ali@38: # ===========================================================================
ali@38: #     http://www.gnu.org/software/autoconf-archive/ax_valgrind_check.html
ali@38: # ===========================================================================
ali@38: #
ali@38: # SYNOPSIS
ali@38: #
ali@38: #   AX_VALGRIND_CHECK()
ali@38: #
ali@38: # DESCRIPTION
ali@38: #
ali@38: #   Checks whether Valgrind is present and, if so, allows running `make
ali@38: #   check` under a variety of Valgrind tools to check for memory and
ali@38: #   threading errors.
ali@38: #
ali@38: #   Defines VALGRIND_CHECK_RULES which should be substituted in your
ali@38: #   Makefile; and $enable_valgrind which can be used in subsequent configure
ali@38: #   output. VALGRIND_ENABLED is defined and substituted, and corresponds to
ali@38: #   the value of the --enable-valgrind option, which defaults to being
ali@38: #   enabled if Valgrind is installed and disabled otherwise.
ali@38: #
ali@38: #   If unit tests are written using a shell script and automake's
ali@38: #   LOG_COMPILER system, the $(VALGRIND) variable can be used within the
ali@38: #   shell scripts to enable Valgrind, as described here:
ali@38: #
ali@38: #     https://www.gnu.org/software/gnulib/manual/html_node/Running-self_002dtests-under-valgrind.html
ali@38: #
ali@38: #   Usage example:
ali@38: #
ali@38: #   configure.ac:
ali@38: #
ali@38: #     AX_VALGRIND_CHECK
ali@38: #
ali@38: #   Makefile.am:
ali@38: #
ali@38: #     @VALGRIND_CHECK_RULES@
ali@38: #     VALGRIND_SUPPRESSIONS_FILES = my-project.supp
ali@38: #     EXTRA_DIST = my-project.supp
ali@38: #
ali@38: #   This results in a "check-valgrind" rule being added to any Makefile.am
ali@38: #   which includes "@VALGRIND_CHECK_RULES@" (assuming the module has been
ali@38: #   configured with --enable-valgrind). Running `make check-valgrind` in
ali@38: #   that directory will run the module's test suite (`make check`) once for
ali@38: #   each of the available Valgrind tools (out of memcheck, helgrind, drd and
ali@38: #   sgcheck), and will output results to test-suite-$toolname.log for each.
ali@38: #   The target will succeed if there are zero errors and fail otherwise.
ali@38: #
ali@38: #   Alternatively, a "check-valgrind-$TOOL" rule will be added, for $TOOL in
ali@38: #   memcheck, helgrind, drd and sgcheck. These are useful because often only
ali@38: #   some of those tools can be ran cleanly on a codebase.
ali@38: #
ali@38: #   The macro supports running with and without libtool.
ali@38: #
ali@38: # LICENSE
ali@38: #
ali@38: #   Copyright (c) 2014, 2015, 2016 Philip Withnall <philip.withnall@collabora.co.uk>
ali@38: #
ali@38: #   Copying and distribution of this file, with or without modification, are
ali@38: #   permitted in any medium without royalty provided the copyright notice
ali@38: #   and this notice are preserved.  This file is offered as-is, without any
ali@38: #   warranty.
ali@38: 
ali@38: #serial 9
ali@38: 
ali@38: AC_DEFUN([AX_VALGRIND_CHECK],[
ali@38: 	dnl Check for --enable-valgrind
ali@38: 	AC_ARG_ENABLE([valgrind],
ali@38: 	              [AS_HELP_STRING([--enable-valgrind], [Whether to enable Valgrind on the unit tests])],
ali@38: 	              [enable_valgrind=$enableval],[enable_valgrind=])
ali@38: 
ali@38: 	AS_IF([test "$enable_valgrind" != "no"],[
ali@38: 		# Check for Valgrind.
ali@38: 		AC_CHECK_PROG([VALGRIND],[valgrind],[valgrind])
ali@38: 		AS_IF([test "$VALGRIND" = ""],[
ali@38: 			AS_IF([test "$enable_valgrind" = "yes"],[
ali@38: 				AC_MSG_ERROR([Could not find valgrind; either install it or reconfigure with --disable-valgrind])
ali@38: 			],[
ali@38: 				enable_valgrind=no
ali@38: 			])
ali@38: 		],[
ali@38: 			enable_valgrind=yes
ali@38: 		])
ali@38: 	])
ali@38: 
ali@38: 	AM_CONDITIONAL([VALGRIND_ENABLED],[test "$enable_valgrind" = "yes"])
ali@38: 	AC_SUBST([VALGRIND_ENABLED],[$enable_valgrind])
ali@38: 
ali@38: 	# Check for Valgrind tools we care about.
ali@38: 	m4_define([valgrind_tool_list],[[memcheck], [helgrind], [drd], [exp-sgcheck]])
ali@38: 
ali@38: 	AS_IF([test "$VALGRIND" != ""],[
ali@38: 		m4_foreach([vgtool],[valgrind_tool_list],[
ali@38: 			m4_define([vgtooln],AS_TR_SH(vgtool))
ali@38: 			m4_define([ax_cv_var],[ax_cv_valgrind_tool_]vgtooln)
ali@38: 			AC_CACHE_CHECK([for Valgrind tool ]vgtool,ax_cv_var,[
ali@38: 				ax_cv_var=
ali@38: 				AS_IF([`$VALGRIND --tool=vgtool --help >/dev/null 2>&1`],[
ali@38: 					ax_cv_var="vgtool"
ali@38: 				])
ali@38: 			])
ali@38: 
ali@38: 			AC_SUBST([VALGRIND_HAVE_TOOL_]vgtooln,[$ax_cv_var])
ali@38: 		])
ali@38: 	])
ali@38: 
ali@38: [VALGRIND_CHECK_RULES='
ali@38: # Valgrind check
ali@38: #
ali@38: # Optional:
ali@38: #  - VALGRIND_SUPPRESSIONS_FILES: Space-separated list of Valgrind suppressions
ali@38: #    files to load. (Default: empty)
ali@38: #  - VALGRIND_FLAGS: General flags to pass to all Valgrind tools.
ali@38: #    (Default: --num-callers=30)
ali@38: #  - VALGRIND_$toolname_FLAGS: Flags to pass to Valgrind $toolname (one of:
ali@38: #    memcheck, helgrind, drd, sgcheck). (Default: various)
ali@38: 
ali@38: # Optional variables
ali@38: VALGRIND_SUPPRESSIONS ?= $(addprefix --suppressions=,$(VALGRIND_SUPPRESSIONS_FILES))
ali@38: VALGRIND_FLAGS ?= --num-callers=30
ali@38: VALGRIND_memcheck_FLAGS ?= --leak-check=full --show-reachable=no
ali@38: VALGRIND_helgrind_FLAGS ?= --history-level=approx
ali@38: VALGRIND_drd_FLAGS ?=
ali@38: VALGRIND_sgcheck_FLAGS ?=
ali@38: 
ali@38: # Internal use
ali@38: valgrind_tools = memcheck helgrind drd sgcheck
ali@38: valgrind_log_files = $(addprefix test-suite-,$(addsuffix .log,$(valgrind_tools)))
ali@38: 
ali@38: valgrind_memcheck_flags = --tool=memcheck $(VALGRIND_memcheck_FLAGS)
ali@38: valgrind_helgrind_flags = --tool=helgrind $(VALGRIND_helgrind_FLAGS)
ali@38: valgrind_drd_flags = --tool=drd $(VALGRIND_drd_FLAGS)
ali@38: valgrind_sgcheck_flags = --tool=exp-sgcheck $(VALGRIND_sgcheck_FLAGS)
ali@38: 
ali@38: valgrind_quiet = $(valgrind_quiet_$(V))
ali@38: valgrind_quiet_ = $(valgrind_quiet_$(AM_DEFAULT_VERBOSITY))
ali@38: valgrind_quiet_0 = --quiet
ali@38: 
ali@38: # Support running with and without libtool.
ali@38: ifneq ($(LIBTOOL),)
ali@38: valgrind_lt = $(LIBTOOL) $(AM_LIBTOOLFLAGS) $(LIBTOOLFLAGS) --mode=execute
ali@38: else
ali@38: valgrind_lt =
ali@38: endif
ali@38: 
ali@38: # Use recursive makes in order to ignore errors during check
ali@38: check-valgrind:
ali@38: ifeq ($(VALGRIND_ENABLED),yes)
ali@38: 	-$(foreach tool,$(valgrind_tools), \
ali@38: 		$(if $(VALGRIND_HAVE_TOOL_$(tool))$(VALGRIND_HAVE_TOOL_exp_$(tool)), \
ali@38: 			$(MAKE) $(AM_MAKEFLAGS) -k check-valgrind-tool VALGRIND_TOOL=$(tool); \
ali@38: 		) \
ali@38: 	)
ali@38: else
ali@38: 	@echo "Need to reconfigure with --enable-valgrind"
ali@38: endif
ali@38: 
ali@38: # Valgrind running
ali@38: VALGRIND_TESTS_ENVIRONMENT = \
ali@38: 	$(TESTS_ENVIRONMENT) \
ali@38: 	env VALGRIND=$(VALGRIND) \
ali@38: 	G_SLICE=always-malloc,debug-blocks \
ali@38: 	G_DEBUG=fatal-warnings,fatal-criticals,gc-friendly
ali@38: 
ali@38: VALGRIND_LOG_COMPILER = \
ali@38: 	$(valgrind_lt) \
ali@38: 	$(VALGRIND) $(VALGRIND_SUPPRESSIONS) --error-exitcode=1 $(VALGRIND_FLAGS)
ali@38: 
ali@38: check-valgrind-tool:
ali@38: ifeq ($(VALGRIND_ENABLED),yes)
ali@38: 	$(MAKE) check-TESTS \
ali@38: 		TESTS_ENVIRONMENT="$(VALGRIND_TESTS_ENVIRONMENT)" \
ali@38: 		LOG_COMPILER="$(VALGRIND_LOG_COMPILER)" \
ali@38: 		LOG_FLAGS="$(valgrind_$(VALGRIND_TOOL)_flags)" \
ali@38: 		TEST_SUITE_LOG=test-suite-$(VALGRIND_TOOL).log
ali@38: else
ali@38: 	@echo "Need to reconfigure with --enable-valgrind"
ali@38: endif
ali@38: 
ali@38: check-valgrind-memcheck:
ali@38: ifeq ($(VALGRIND_ENABLED),yes)
ali@38: 	$(MAKE) check-TESTS \
ali@38: 		TESTS_ENVIRONMENT="$(VALGRIND_TESTS_ENVIRONMENT)" \
ali@38: 		LOG_COMPILER="$(VALGRIND_LOG_COMPILER)" \
ali@38: 		LOG_FLAGS="$(valgrind_memcheck_flags)" \
ali@38: 		TEST_SUITE_LOG=test-suite-memcheck.log
ali@38: else
ali@38: 	@echo "Need to reconfigure with --enable-valgrind"
ali@38: endif
ali@38: 
ali@38: check-valgrind-helgrind:
ali@38: ifeq ($(VALGRIND_ENABLED),yes)
ali@38: 	$(MAKE) check-TESTS \
ali@38: 		TESTS_ENVIRONMENT="$(VALGRIND_TESTS_ENVIRONMENT)" \
ali@38: 		LOG_COMPILER="$(VALGRIND_LOG_COMPILER)" \
ali@38: 		LOG_FLAGS="$(valgrind_helgrind_flags)" \
ali@38: 		TEST_SUITE_LOG=test-suite-helgrind.log
ali@38: else
ali@38: 	@echo "Need to reconfigure with --enable-valgrind"
ali@38: endif
ali@38: 
ali@38: check-valgrind-drd:
ali@38: ifeq ($(VALGRIND_ENABLED),yes)
ali@38: 	$(MAKE) check-TESTS \
ali@38: 		TESTS_ENVIRONMENT="$(VALGRIND_TESTS_ENVIRONMENT)" \
ali@38: 		LOG_COMPILER="$(VALGRIND_LOG_COMPILER)" \
ali@38: 		LOG_FLAGS="$(valgrind_drd_flags)" \
ali@38: 		TEST_SUITE_LOG=test-suite-drd.log
ali@38: else
ali@38: 	@echo "Need to reconfigure with --enable-valgrind"
ali@38: endif
ali@38: 
ali@38: check-valgrind-sgcheck:
ali@38: ifeq ($(VALGRIND_ENABLED),yes)
ali@38: 	$(MAKE) check-TESTS \
ali@38: 		TESTS_ENVIRONMENT="$(VALGRIND_TESTS_ENVIRONMENT)" \
ali@38: 		LOG_COMPILER="$(VALGRIND_LOG_COMPILER)" \
ali@38: 		LOG_FLAGS="$(valgrind_sgcheck_flags)" \
ali@38: 		TEST_SUITE_LOG=test-suite-sgcheck.log
ali@38: else
ali@38: 	@echo "Need to reconfigure with --enable-valgrind"
ali@38: endif
ali@38: 
ali@38: A''M_DISTCHECK_CONFIGURE_FLAGS ?=
ali@38: A''M_DISTCHECK_CONFIGURE_FLAGS += --disable-valgrind
ali@38: 
ali@38: MOSTLYCLEANFILES ?=
ali@38: MOSTLYCLEANFILES += $(valgrind_log_files)
ali@38: 
ali@38: .PHONY: check-valgrind check-valgrind-tool
ali@38: ']
ali@38: 
ali@38: 	AC_SUBST([VALGRIND_CHECK_RULES])
ali@38: 	m4_ifdef([_AM_SUBST_NOTMAKE], [_AM_SUBST_NOTMAKE([VALGRIND_CHECK_RULES])])
ali@38: ])