diff --git a/Demo/Makefile.am b/Demo/Makefile.am new file mode 100644 --- /dev/null +++ b/Demo/Makefile.am @@ -0,0 +1,46 @@ +AM_CPPFLAGS = -I$(top_srcdir)/Include $(AMD_CFLAGS) $(COLAMD_CFLAGS) $(BTF_CFLAGS) $(CHOLMOD_CFLAGS) +LDADD = $(top_builddir)/Source/libklu.la + +EXTRA_DIST = \ + klu_simple.out \ + kludemo.out + +# Disable the .out implicit pattern rule. Prevents GNU make from +# adding bogus dependencies for the .out files listed above. +%.out: % + +check_PROGRAMS = klu_simple +TESTS = klu_simple +klu_simple_SOURCES = klu_simple.c + +if CHOLMOD +check_PROGRAMS += kludemo kluldemo + +kludemo_SOURCES = kludemo.c +kludemo_LDADD = $(LDADD) $(CHOLMOD_LIBS) -lm + +kluldemo_SOURCES = kluldemo.c +kluldemo_LDADD = $(LDADD) $(CHOLMOD_LIBS) -lm + +MATRICES = \ + $(top_srcdir)/Matrix/1c.mtx \ + $(top_srcdir)/Matrix/arrowc.mtx \ + $(top_srcdir)/Matrix/arrow.mtx \ + $(top_srcdir)/Matrix/impcol_a.mtx \ + $(top_srcdir)/Matrix/w156.mtx \ + $(top_srcdir)/Matrix/ctina.mtx + +check-local: kludemo kluldemo $(MATRICES) + -./kludemo < $(top_srcdir)/Matrix/1c.mtx + -./kludemo < $(top_srcdir)/Matrix/arrowc.mtx + -./kludemo < $(top_srcdir)/Matrix/arrow.mtx + -./kludemo < $(top_srcdir)/Matrix/impcol_a.mtx + -./kludemo < $(top_srcdir)/Matrix/w156.mtx + -./kludemo < $(top_srcdir)/Matrix/ctina.mtx + -./kluldemo < $(top_srcdir)/Matrix/1c.mtx + -./kluldemo < $(top_srcdir)/Matrix/arrowc.mtx + -./kluldemo < $(top_srcdir)/Matrix/arrow.mtx + -./kluldemo < $(top_srcdir)/Matrix/impcol_a.mtx + -./kluldemo < $(top_srcdir)/Matrix/w156.mtx + -./kluldemo < $(top_srcdir)/Matrix/ctina.mtx +endif diff --git a/Doc/Makefile.am b/Doc/Makefile.am new file mode 100644 --- /dev/null +++ b/Doc/Makefile.am @@ -0,0 +1,51 @@ +EXTRA_DIST = \ + ChangeLog \ + License.txt \ + lesser.txt + +dist_noinst_DATA = KLU_UserGuide.tex KLU_UserGuide.bib +dist_pdf_DATA = KLU_UserGuide.pdf palamadai_e.pdf + +SRC = \ + klu_h.tex \ + btf_h.tex \ + klu_simple_c.tex + +KLU_UserGuide.pdf KLU_UserGuide.aux: $(SRC) +.INTERMEDIATE: KLU_UserGuide.aux $(SRC) + +define verbatim = +echo '\begin{verbatim}' > $@ +expand -8 $< >> $@ +echo '\end{verbatim}' >> $@ +endef + +klu_h.tex: $(top_srcdir)/Include/klu.h + $(verbatim) + +# FIXME: We don't know the location of btf.h. +# Insert a placeholder for now. +#btf_h.tex: /usr/include/btf.h +# $(verbatim) +btf_h.tex: + echo '\begin{verbatim}' > $@ + echo 'See your btf.h local install' >> $@ + echo '\end{verbatim}' >> $@ + +klu_simple_c.tex: $(top_srcdir)/Demo/klu_simple.c + $(verbatim) + +TEX = TEXINPUTS="$(srcdir):" pdflatex -interaction nonstopmode -file-line-error +BIB = BIBINPUTS="$(srcdir):" bibtex +%.pdf: %.tex %.bbl + $(TEX) $* + while grep -q "Rerun to get cross-references right" $*.log; do \ + $(TEX) $*; \ + done +%.bbl: %.aux %.bib + $(BIB) $* +%.aux: %.tex + $(TEX) $* + +CLEANFILES = *.aux *.bbl *.blg *.log *.toc $(SRC) +MAINTAINERCLEANFILES = $(dist_pdf_DATA) diff --git a/Include/Makefile.am b/Include/Makefile.am new file mode 100644 --- /dev/null +++ b/Include/Makefile.am @@ -0,0 +1 @@ +pkginclude_HEADERS = klu.h klu_internal.h klu_version.h diff --git a/Makefile.am b/Makefile.am new file mode 100644 --- /dev/null +++ b/Makefile.am @@ -0,0 +1,9 @@ +ACLOCAL_AMFLAGS = -I m4 + +SUBDIRS = Include Source User Matrix Demo Tcov Doc +EXTRA_DIST = README.txt + +pkgconfig_DATA = klu.pc + +CODE_COVERAGE_BRANCH_COVERAGE = 1 +@CODE_COVERAGE_RULES@ diff --git a/Matrix/Makefile.am b/Matrix/Makefile.am new file mode 100644 --- /dev/null +++ b/Matrix/Makefile.am @@ -0,0 +1,11 @@ +dist_noinst_DATA = \ + 1c.mtx \ + GD99_cc.mtx \ + arrow.mtx \ + arrowc.mtx \ + ctina.mtx \ + impcol_a.mtx \ + one.mtx \ + onec.mtx \ + two.mtx \ + w156.mtx diff --git a/Source/Makefile.am b/Source/Makefile.am new file mode 100644 --- /dev/null +++ b/Source/Makefile.am @@ -0,0 +1,49 @@ +AM_CPPFLAGS = -I$(top_srcdir)/Include $(AMD_CFLAGS) $(COLAMD_CFLAGS) $(BTF_CFLAGS) $(SUITESPARSECONFIG_CFLAGS) + +noinst_LTLIBRARIES = libklud.la libkluz.la libklul.la libkluzl.la + +KLUSRC = \ + klu.c \ + klu_diagnostics.c \ + klu_dump.c \ + klu_extract.c \ + klu_factor.c \ + klu_free_numeric.c \ + klu_kernel.c \ + klu_refactor.c \ + klu_scale.c \ + klu_solve.c \ + klu_sort.c \ + klu_tsolve.c + +CKLUSRC = \ + klu_analyze.c \ + klu_analyze_given.c \ + klu_defaults.c \ + klu_free_symbolic.c \ + klu_memory.c + +libklud_la_SOURCES = $(KLUSRC) $(CKLUSRC) +libklud_la_LIBADD = $(CODE_COVERAGE_LIBS) +libklud_la_CPPFLAGS = $(AM_CPPFLAGS) $(CODE_COVERAGE_CPPFLAGS) +libklud_la_CFLAGS = $(AM_CFLAGS) $(CODE_COVERAGE_CFLAGS) + +libkluz_la_SOURCES = $(KLUSRC) +libkluz_la_LIBADD = $(CODE_COVERAGE_LIBS) +libkluz_la_CPPFLAGS = $(AM_CPPFLAGS) $(CODE_COVERAGE_CPPFLAGS) -DCOMPLEX +libkluz_la_CFLAGS = $(AM_CFLAGS) $(CODE_COVERAGE_CFLAGS) + +libklul_la_SOURCES = $(KLUSRC) $(CKLUSRC) +libklul_la_LIBADD = $(CODE_COVERAGE_LIBS) +libklul_la_CPPFLAGS = $(AM_CPPFLAGS) $(CODE_COVERAGE_CPPFLAGS) -DDLONG +libklul_la_CFLAGS = $(AM_CFLAGS) $(CODE_COVERAGE_CFLAGS) + +libkluzl_la_SOURCES = $(KLUSRC) +libkluzl_la_LIBADD = $(CODE_COVERAGE_LIBS) +libkluzl_la_CPPFLAGS = $(AM_CPPFLAGS) $(CODE_COVERAGE_CPPFLAGS) -DDLONG -DCOMPLEX +libkluzl_la_CFLAGS = $(AM_CFLAGS) $(CODE_COVERAGE_CFLAGS) + +lib_LTLIBRARIES = libklu.la +libklu_la_SOURCES = +libklu_la_LIBADD = libklud.la libkluz.la libklul.la libkluzl.la $(AMD_LIBS) $(COLAMD_LIBS) $(BTF_LIBS) $(SUITESPARSECONFIG_LIBS) +libklu_la_LDFLAGS = -no-undefined -release $(PACKAGE_VERSION) diff --git a/Tcov/Makefile.am b/Tcov/Makefile.am new file mode 100644 --- /dev/null +++ b/Tcov/Makefile.am @@ -0,0 +1,54 @@ +AM_CPPFLAGS = -I$(top_srcdir)/Include -I$(top_srcdir)/User $(AMD_CFLAGS) $(COLAMD_CFLAGS) $(BTF_CFLAGS) $(CHOLMOD_CFLAGS) +LDADD = $(top_builddir)/Source/libklu.la $(top_builddir)/User/libklu_cholmod.la + +EXTRA_DIST = \ + README.txt + +if CODE_COVERAGE_ENABLED +check_PROGRAMS = \ + klutest \ + klultest + +klutest_SOURCES = klutest.c +klutest_LDADD = $(LDADD) $(CHOLMOD_LIBS) $(SUITESPARSECONFIG_LIBS) + +klultest_SOURCES = klutest.c +klultest_LDADD = $(LDADD) $(CHOLMOD_LIBS) $(SUITESPARSECONFIG_LIBS) +klultest_CPPFLAGS = $(AM_CPPFLAGS) -DDLONG + +MATRICES = \ + $(top_srcdir)/Matrix/1c.mtx \ + $(top_srcdir)/Matrix/GD99_cc.mtx \ + $(top_srcdir)/Matrix/arrow.mtx \ + $(top_srcdir)/Matrix/arrowc.mtx \ + $(top_srcdir)/Matrix/ctina.mtx \ + $(top_srcdir)/Matrix/impcol_a.mtx \ + $(top_srcdir)/Matrix/one.mtx \ + $(top_srcdir)/Matrix/onec.mtx \ + $(top_srcdir)/Matrix/two.mtx \ + $(top_srcdir)/Matrix/w156.mtx + +check-local: $(check_PROGRAMS) $(MATRICES) + ./klultest < $(top_srcdir)/Matrix/impcol_a.mtx > klultests.out + ./klultest < $(top_srcdir)/Matrix/GD99_cc.mtx >> klultests.out + ./klultest < $(top_srcdir)/Matrix/two.mtx >> klultests.out + ./klultest < $(top_srcdir)/Matrix/w156.mtx >> klultests.out + ./klultest < $(top_srcdir)/Matrix/arrow.mtx >> klultests.out + ./klultest < $(top_srcdir)/Matrix/arrowc.mtx >> klultests.out + ./klultest < $(top_srcdir)/Matrix/onec.mtx >> klultests.out + ./klultest < $(top_srcdir)/Matrix/one.mtx >> klultests.out + ./klultest < $(top_srcdir)/Matrix/1c.mtx >> klultests.out + ./klultest < $(top_srcdir)/Matrix/ctina.mtx >> klultests.out + ./klutest < $(top_srcdir)/Matrix/impcol_a.mtx > klutests.out + ./klutest < $(top_srcdir)/Matrix/GD99_cc.mtx >> klutests.out + ./klutest < $(top_srcdir)/Matrix/two.mtx >> klutests.out + ./klutest < $(top_srcdir)/Matrix/w156.mtx >> klutests.out + ./klutest < $(top_srcdir)/Matrix/arrow.mtx >> klutests.out + ./klutest < $(top_srcdir)/Matrix/arrowc.mtx >> klutests.out + ./klutest < $(top_srcdir)/Matrix/onec.mtx >> klutests.out + ./klutest < $(top_srcdir)/Matrix/one.mtx >> klutests.out + ./klutest < $(top_srcdir)/Matrix/1c.mtx >> klutests.out + ./klutest < $(top_srcdir)/Matrix/ctina.mtx >> klutests.out +endif + +CLEANFILES = *.out diff --git a/User/Makefile.am b/User/Makefile.am new file mode 100644 --- /dev/null +++ b/User/Makefile.am @@ -0,0 +1,14 @@ +AM_CPPFLAGS = -I$(top_srcdir)/Include $(AMD_CFLAGS) $(COLAMD_CFLAGS) $(BTF_CFLAGS) $(CHOLMOD_CFLAGS) $(SUITESPARSECONFIG_CFLAGS) + +EXTRA_DIST = README.txt + +if CHOLMOD +pkginclude_HEADERS = klu_cholmod.h + +lib_LTLIBRARIES = libklu_cholmod.la +libklu_cholmod_la_SOURCES = klu_cholmod.c klu_l_cholmod.c +libklu_cholmod_la_LIBADD = $(CHOLMOD_LIBS) $(CODE_COVERAGE_LIBS) +libklu_cholmod_la_CPPFLAGS = $(AM_CPPFLAGS) $(CODE_COVERAGE_CPPFLAGS) +libklu_cholmod_la_CFLAGS = $(AM_CFLAGS) $(CODE_COVERAGE_CFLAGS) +libklu_cholmod_la_LDFLAGS = -no-undefined -release $(PACKAGE_VERSION) +endif diff --git a/configure.ac b/configure.ac new file mode 100644 --- /dev/null +++ b/configure.ac @@ -0,0 +1,59 @@ +# -*- Autoconf -*- +# Process this file with autoconf to produce a configure script. + +AC_PREREQ([2.69]) +AC_INIT([KLU],[1.3.9],[https://github.com/DrTimothyAldenDavis/SuiteSparse],[klu],[http://www.suitesparse.com/]) +AC_CONFIG_SRCDIR([Source/klu.c]) +AC_CONFIG_AUX_DIR([build-aux]) +AC_CONFIG_MACRO_DIR([m4]) +AC_CONFIG_HEADERS([config.h]) +AM_INIT_AUTOMAKE([foreign]) +AM_SILENT_RULES([yes]) +LT_INIT([disable-static]) + +# Checks for programs. +PKG_PROG_PKG_CONFIG +AC_PROG_INSTALL +AC_PROG_CC +AX_CODE_COVERAGE + +AS_VAR_SET([LIBS_SAVED], [$LIBS]) + +# Checks for libraries. +AC_CHECK_LIB([m], [sqrt]) + +PKG_CHECK_MODULES([SUITESPARSECONFIG], [suitesparseconfig]) +PKG_CHECK_MODULES([AMD], [amd]) +PKG_CHECK_MODULES([COLAMD], [colamd]) +PKG_CHECK_MODULES([BTF], [btf]) +PKG_CHECK_MODULES([CHOLMOD], [cholmod], + [AS_VAR_SET([have_cholmod], [yes])], + [AS_VAR_SET([have_cholmod], [no]) + AC_MSG_WARN([$CHOLMOD_PKG_ERRORS, disabling some functionality])]) + +# Checks for header files. +AC_CHECK_HEADERS([limits.h stdlib.h]) + +# Checks for typedefs, structures, and compiler characteristics. +AC_TYPE_SIZE_T + +# Checks for library functions. +AC_CHECK_FUNCS([sqrt]) + +AS_VAR_SET([LIBS], [$LIBS_SAVED]) + +AM_CONDITIONAL([CHOLMOD], [test "x$have_cholmod" = "xyes"]) + +m4_ifdef([PKG_INSTALLDIR], [PKG_INSTALLDIR], [AC_SUBST([pkgconfigdir], [${libdir}/pkgconfig])]) +AC_CONFIG_FILES([ + klu.pc + Makefile + Demo/Makefile + Doc/Makefile + Include/Makefile + Matrix/Makefile + Source/Makefile + Tcov/Makefile + User/Makefile +]) +AC_OUTPUT diff --git a/klu.pc.in b/klu.pc.in new file mode 100644 --- /dev/null +++ b/klu.pc.in @@ -0,0 +1,13 @@ +prefix=@prefix@ +exec_prefix=@exec_prefix@ +libdir=@libdir@ +includedir=@includedir@ + +Name: @PACKAGE_NAME@ +Description: Sparse LU factorization for circuit simulation +Version: @PACKAGE_VERSION@ +URL: @PACKAGE_URL@ +Requires.private: suitesparseconfig amd colamd btf +Libs: -L${libdir} -lklu +Libs.private: -lm +Cflags: -I${includedir}/klu diff --git a/m4/ax_code_coverage.m4 b/m4/ax_code_coverage.m4 new file mode 100644 --- /dev/null +++ b/m4/ax_code_coverage.m4 @@ -0,0 +1,271 @@ +# =========================================================================== +# https://www.gnu.org/software/autoconf-archive/ax_code_coverage.html +# =========================================================================== +# +# SYNOPSIS +# +# AX_CODE_COVERAGE() +# +# DESCRIPTION +# +# Defines CODE_COVERAGE_CPPFLAGS, CODE_COVERAGE_CFLAGS, +# CODE_COVERAGE_CXXFLAGS and CODE_COVERAGE_LIBS which should be included +# in the CPPFLAGS, CFLAGS CXXFLAGS and LIBS/LIBADD variables of every +# build target (program or library) which should be built with code +# coverage support. Also defines CODE_COVERAGE_RULES which should be +# substituted in your Makefile; and $enable_code_coverage which can be +# used in subsequent configure output. CODE_COVERAGE_ENABLED is defined +# and substituted, and corresponds to the value of the +# --enable-code-coverage option, which defaults to being disabled. +# +# Test also for gcov program and create GCOV variable that could be +# substituted. +# +# Note that all optimization flags in CFLAGS must be disabled when code +# coverage is enabled. +# +# Usage example: +# +# configure.ac: +# +# AX_CODE_COVERAGE +# +# Makefile.am: +# +# @CODE_COVERAGE_RULES@ +# my_program_LIBS = ... $(CODE_COVERAGE_LIBS) ... +# my_program_CPPFLAGS = ... $(CODE_COVERAGE_CPPFLAGS) ... +# my_program_CFLAGS = ... $(CODE_COVERAGE_CFLAGS) ... +# my_program_CXXFLAGS = ... $(CODE_COVERAGE_CXXFLAGS) ... +# +# This results in a "check-code-coverage" rule being added to any +# Makefile.am which includes "@CODE_COVERAGE_RULES@" (assuming the module +# has been configured with --enable-code-coverage). Running `make +# check-code-coverage` in that directory will run the module's test suite +# (`make check`) and build a code coverage report detailing the code which +# was touched, then print the URI for the report. +# +# In earlier versions of this macro, CODE_COVERAGE_LDFLAGS was defined +# instead of CODE_COVERAGE_LIBS. They are both still defined, but use of +# CODE_COVERAGE_LIBS is preferred for clarity; CODE_COVERAGE_LDFLAGS is +# deprecated. They have the same value. +# +# This code was derived from Makefile.decl in GLib, originally licenced +# under LGPLv2.1+. +# +# LICENSE +# +# Copyright (c) 2012, 2016 Philip Withnall +# Copyright (c) 2012 Xan Lopez +# Copyright (c) 2012 Christian Persch +# Copyright (c) 2012 Paolo Borelli +# Copyright (c) 2012 Dan Winship +# Copyright (c) 2015 Bastien ROUCARIES +# +# This library is free software; you can redistribute it and/or modify it +# under the terms of the GNU Lesser General Public License as published by +# the Free Software Foundation; either version 2.1 of the License, or (at +# your option) any later version. +# +# This library 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 Lesser +# General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public License +# along with this program. If not, see . + +#serial 27 + +AC_DEFUN([_AX_CODE_COVERAGE_ENABLED],[ + # check for gcov + AC_CHECK_TOOL([GCOV], + [$_AX_CODE_COVERAGE_GCOV_PROG_WITH], + [:]) + AS_IF([test "X$GCOV" = "X:"], + [AC_MSG_ERROR([gcov is needed to do coverage])]) + AC_SUBST([GCOV]) + + dnl Check if gcc is being used + AS_IF([ test "$GCC" = "no" ], [ + AC_MSG_ERROR([not compiling with gcc, which is required for gcov code coverage]) + ]) + + AC_CHECK_PROG([LCOV], [lcov], [lcov]) + AC_CHECK_PROG([GENHTML], [genhtml], [genhtml]) + + AS_IF([ test x"$LCOV" = x ], [ + AC_MSG_ERROR([To enable code coverage reporting you must have lcov installed]) + ]) + + AS_IF([ test x"$GENHTML" = x ], [ + AC_MSG_ERROR([Could not find genhtml from the lcov package]) + ]) + + dnl Build the code coverage flags + dnl Define CODE_COVERAGE_LDFLAGS for backwards compatibility + CODE_COVERAGE_CPPFLAGS="-DNDEBUG" + CODE_COVERAGE_CFLAGS="-O0 -g -fprofile-arcs -ftest-coverage" + CODE_COVERAGE_CXXFLAGS="-O0 -g -fprofile-arcs -ftest-coverage" + CODE_COVERAGE_LIBS="-lgcov" + CODE_COVERAGE_LDFLAGS="$CODE_COVERAGE_LIBS" + + AC_SUBST([CODE_COVERAGE_CPPFLAGS]) + AC_SUBST([CODE_COVERAGE_CFLAGS]) + AC_SUBST([CODE_COVERAGE_CXXFLAGS]) + AC_SUBST([CODE_COVERAGE_LIBS]) + AC_SUBST([CODE_COVERAGE_LDFLAGS]) + + [CODE_COVERAGE_RULES_CHECK=' + -$(A''M_V_at)$(MAKE) $(AM_MAKEFLAGS) -k check + $(A''M_V_at)$(MAKE) $(AM_MAKEFLAGS) code-coverage-capture +'] + [CODE_COVERAGE_RULES_CAPTURE=' + $(code_coverage_v_lcov_cap)$(LCOV) $(code_coverage_quiet) $(addprefix --directory ,$(CODE_COVERAGE_DIRECTORY)) --capture --output-file "$(CODE_COVERAGE_OUTPUT_FILE).tmp" --test-name "$(call code_coverage_sanitize,$(PACKAGE_NAME)-$(PACKAGE_VERSION))" --no-checksum --compat-libtool $(CODE_COVERAGE_LCOV_SHOPTS) $(CODE_COVERAGE_LCOV_OPTIONS) + $(code_coverage_v_lcov_ign)$(LCOV) $(code_coverage_quiet) $(addprefix --directory ,$(CODE_COVERAGE_DIRECTORY)) --remove "$(CODE_COVERAGE_OUTPUT_FILE).tmp" "/tmp/*" $(CODE_COVERAGE_IGNORE_PATTERN) --output-file "$(CODE_COVERAGE_OUTPUT_FILE)" $(CODE_COVERAGE_LCOV_SHOPTS) $(CODE_COVERAGE_LCOV_RMOPTS) + -@rm -f $(CODE_COVERAGE_OUTPUT_FILE).tmp + $(code_coverage_v_genhtml)LANG=C $(GENHTML) $(code_coverage_quiet) $(addprefix --prefix ,$(CODE_COVERAGE_DIRECTORY)) --output-directory "$(CODE_COVERAGE_OUTPUT_DIRECTORY)" --title "$(PACKAGE_NAME)-$(PACKAGE_VERSION) Code Coverage" --legend --show-details "$(CODE_COVERAGE_OUTPUT_FILE)" $(CODE_COVERAGE_GENHTML_OPTIONS) + @echo "file://$(abs_builddir)/$(CODE_COVERAGE_OUTPUT_DIRECTORY)/index.html" +'] + [CODE_COVERAGE_RULES_CLEAN=' +clean: code-coverage-clean +distclean: code-coverage-clean +code-coverage-clean: + -$(LCOV) --directory $(top_builddir) -z + -rm -rf $(CODE_COVERAGE_OUTPUT_FILE) $(CODE_COVERAGE_OUTPUT_FILE).tmp $(CODE_COVERAGE_OUTPUT_DIRECTORY) + -find . \( -name "*.gcda" -o -name "*.gcno" -o -name "*.gcov" \) -delete +'] +]) + +AC_DEFUN([_AX_CODE_COVERAGE_DISABLED],[ + [CODE_COVERAGE_RULES_CHECK=' + @echo "Need to reconfigure with --enable-code-coverage" + '] + CODE_COVERAGE_RULES_CAPTURE="$CODE_COVERAGE_RULES_CHECK" + CODE_COVERAGE_RULES_CLEAN='' +]) + +AC_DEFUN([AX_CODE_COVERAGE],[ + dnl Check for --enable-code-coverage + + # allow to override gcov location + AC_ARG_WITH([gcov], + [AS_HELP_STRING([--with-gcov[=GCOV]], [use given GCOV for coverage (GCOV=gcov).])], + [_AX_CODE_COVERAGE_GCOV_PROG_WITH=$with_gcov], + [_AX_CODE_COVERAGE_GCOV_PROG_WITH=gcov]) + + AC_MSG_CHECKING([whether to build with code coverage support]) + AC_ARG_ENABLE([code-coverage], + AS_HELP_STRING([--enable-code-coverage], + [Whether to enable code coverage support]),, + enable_code_coverage=no) + + AM_CONDITIONAL([CODE_COVERAGE_ENABLED], [test "x$enable_code_coverage" = xyes]) + AC_SUBST([CODE_COVERAGE_ENABLED], [$enable_code_coverage]) + AC_MSG_RESULT($enable_code_coverage) + + AS_IF([ test "x$enable_code_coverage" = xyes ], [ + _AX_CODE_COVERAGE_ENABLED + ], [ + _AX_CODE_COVERAGE_DISABLED + ]) + +[CODE_COVERAGE_RULES=' +# Code coverage +# +# Optional: +# - CODE_COVERAGE_DIRECTORY: Top-level directory for code coverage reporting. +# Multiple directories may be specified, separated by whitespace. +# (Default: $(top_builddir)) +# - CODE_COVERAGE_OUTPUT_FILE: Filename and path for the .info file generated +# by lcov for code coverage. (Default: +# $(PACKAGE_NAME)-$(PACKAGE_VERSION)-coverage.info) +# - CODE_COVERAGE_OUTPUT_DIRECTORY: Directory for generated code coverage +# reports to be created. (Default: +# $(PACKAGE_NAME)-$(PACKAGE_VERSION)-coverage) +# - CODE_COVERAGE_BRANCH_COVERAGE: Set to 1 to enforce branch coverage, +# set to 0 to disable it and leave empty to stay with the default. +# (Default: empty) +# - CODE_COVERAGE_LCOV_SHOPTS_DEFAULT: Extra options shared between both lcov +# instances. (Default: based on $CODE_COVERAGE_BRANCH_COVERAGE) +# - CODE_COVERAGE_LCOV_SHOPTS: Extra options to shared between both lcov +# instances. (Default: $CODE_COVERAGE_LCOV_SHOPTS_DEFAULT) +# - CODE_COVERAGE_LCOV_OPTIONS_GCOVPATH: --gcov-tool pathtogcov +# - CODE_COVERAGE_LCOV_OPTIONS_DEFAULT: Extra options to pass to the +# collecting lcov instance. (Default: $CODE_COVERAGE_LCOV_OPTIONS_GCOVPATH) +# - CODE_COVERAGE_LCOV_OPTIONS: Extra options to pass to the collecting lcov +# instance. (Default: $CODE_COVERAGE_LCOV_OPTIONS_DEFAULT) +# - CODE_COVERAGE_LCOV_RMOPTS_DEFAULT: Extra options to pass to the filtering +# lcov instance. (Default: empty) +# - CODE_COVERAGE_LCOV_RMOPTS: Extra options to pass to the filtering lcov +# instance. (Default: $CODE_COVERAGE_LCOV_RMOPTS_DEFAULT) +# - CODE_COVERAGE_GENHTML_OPTIONS_DEFAULT: Extra options to pass to the +# genhtml instance. (Default: based on $CODE_COVERAGE_BRANCH_COVERAGE) +# - CODE_COVERAGE_GENHTML_OPTIONS: Extra options to pass to the genhtml +# instance. (Default: $CODE_COVERAGE_GENHTML_OPTIONS_DEFAULT) +# - CODE_COVERAGE_IGNORE_PATTERN: Extra glob pattern of files to ignore +# +# The generated report will be titled using the $(PACKAGE_NAME) and +# $(PACKAGE_VERSION). In order to add the current git hash to the title, +# use the git-version-gen script, available online. + +# Optional variables +CODE_COVERAGE_DIRECTORY ?= $(top_builddir) +CODE_COVERAGE_OUTPUT_FILE ?= $(PACKAGE_NAME)-$(PACKAGE_VERSION)-coverage.info +CODE_COVERAGE_OUTPUT_DIRECTORY ?= $(PACKAGE_NAME)-$(PACKAGE_VERSION)-coverage +CODE_COVERAGE_BRANCH_COVERAGE ?= +CODE_COVERAGE_LCOV_SHOPTS_DEFAULT ?= $(if $(CODE_COVERAGE_BRANCH_COVERAGE),\ +--rc lcov_branch_coverage=$(CODE_COVERAGE_BRANCH_COVERAGE)) +CODE_COVERAGE_LCOV_SHOPTS ?= $(CODE_COVERAGE_LCOV_SHOPTS_DEFAULT) +CODE_COVERAGE_LCOV_OPTIONS_GCOVPATH ?= --gcov-tool "$(GCOV)" +CODE_COVERAGE_LCOV_OPTIONS_DEFAULT ?= $(CODE_COVERAGE_LCOV_OPTIONS_GCOVPATH) +CODE_COVERAGE_LCOV_OPTIONS ?= $(CODE_COVERAGE_LCOV_OPTIONS_DEFAULT) +CODE_COVERAGE_LCOV_RMOPTS_DEFAULT ?= +CODE_COVERAGE_LCOV_RMOPTS ?= $(CODE_COVERAGE_LCOV_RMOPTS_DEFAULT) +CODE_COVERAGE_GENHTML_OPTIONS_DEFAULT ?=\ +$(if $(CODE_COVERAGE_BRANCH_COVERAGE),\ +--rc genhtml_branch_coverage=$(CODE_COVERAGE_BRANCH_COVERAGE)) +CODE_COVERAGE_GENHTML_OPTIONS ?= $(CODE_COVERAGE_GENHTML_OPTIONS_DEFAULT) +CODE_COVERAGE_IGNORE_PATTERN ?= + +GITIGNOREFILES ?= +GITIGNOREFILES += $(CODE_COVERAGE_OUTPUT_FILE) $(CODE_COVERAGE_OUTPUT_DIRECTORY) + +code_coverage_v_lcov_cap = $(code_coverage_v_lcov_cap_$(V)) +code_coverage_v_lcov_cap_ = $(code_coverage_v_lcov_cap_$(AM_DEFAULT_VERBOSITY)) +code_coverage_v_lcov_cap_0 = @echo " LCOV --capture"\ + $(CODE_COVERAGE_OUTPUT_FILE); +code_coverage_v_lcov_ign = $(code_coverage_v_lcov_ign_$(V)) +code_coverage_v_lcov_ign_ = $(code_coverage_v_lcov_ign_$(AM_DEFAULT_VERBOSITY)) +code_coverage_v_lcov_ign_0 = @echo " LCOV --remove /tmp/*"\ + $(CODE_COVERAGE_IGNORE_PATTERN); +code_coverage_v_genhtml = $(code_coverage_v_genhtml_$(V)) +code_coverage_v_genhtml_ = $(code_coverage_v_genhtml_$(AM_DEFAULT_VERBOSITY)) +code_coverage_v_genhtml_0 = @echo " GEN " $(CODE_COVERAGE_OUTPUT_DIRECTORY); +code_coverage_quiet = $(code_coverage_quiet_$(V)) +code_coverage_quiet_ = $(code_coverage_quiet_$(AM_DEFAULT_VERBOSITY)) +code_coverage_quiet_0 = --quiet + +# sanitizes the test-name: replaces with underscores: dashes and dots +code_coverage_sanitize = $(subst -,_,$(subst .,_,$(1))) + +# Use recursive makes in order to ignore errors during check +check-code-coverage:'"$CODE_COVERAGE_RULES_CHECK"' + +# Capture code coverage data +code-coverage-capture: code-coverage-capture-hook'"$CODE_COVERAGE_RULES_CAPTURE"' + +# Hook rule executed before code-coverage-capture, overridable by the user +code-coverage-capture-hook: + +'"$CODE_COVERAGE_RULES_CLEAN"' + +A''M_DISTCHECK_CONFIGURE_FLAGS ?= +A''M_DISTCHECK_CONFIGURE_FLAGS += --disable-code-coverage + +.PHONY: check-code-coverage code-coverage-capture code-coverage-capture-hook code-coverage-clean +'] + + AC_SUBST([CODE_COVERAGE_RULES]) + m4_ifdef([_AM_SUBST_NOTMAKE], [_AM_SUBST_NOTMAKE([CODE_COVERAGE_RULES])]) +])