Makefile.am

   1 # Copyright (c) 2001-2004, Roger Dingledine
   2 # Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson
   3 # Copyright (c) 2007-2017, The Tor Project, Inc.
   4 # See LICENSE for licensing information
   5
   6 ACLOCAL_AMFLAGS = -I m4
   7
   8 noinst_LIBRARIES=
   9 EXTRA_DIST=
  10 noinst_HEADERS=
  11 bin_PROGRAMS=
  12 EXTRA_PROGRAMS=
  13 CLEANFILES=
  14 TESTS=
  15 noinst_PROGRAMS=
  16 DISTCLEANFILES=
  17 bin_SCRIPTS=
  18 AM_CPPFLAGS=
  19 AM_CFLAGS=@TOR_SYSTEMD_CFLAGS@ @CFLAGS_BUGTRAP@ @TOR_LZMA_CFLAGS@ @TOR_ZSTD_CFLAGS@
  20 SHELL=@SHELL@
  21
  22 if COVERAGE_ENABLED
  23 TESTING_TOR_BINARY=$(top_builddir)/src/or/tor-cov$(EXEEXT)
  24 else
  25 TESTING_TOR_BINARY=$(top_builddir)/src/or/tor$(EXEEXT)
  26 endif
  27
  28 if USE_RUST
  29 ## this MUST be $(), otherwise am__DEPENDENCIES will not track it
  30 rust_ldadd=$(top_builddir)/$(TOR_RUST_LIB_PATH) \
  31         $(TOR_RUST_EXTRA_LIBS)
  32 else
  33 rust_ldadd=
  34 endif
  35
  36 include src/include.am
  37 include doc/include.am
  38 include contrib/include.am
  39
  40 EXTRA_DIST+= \
  41         ChangeLog                                       \
  42         CONTRIBUTING                                    \
  43         INSTALL                                         \
  44         LICENSE                                         \
  45         Makefile.nmake                                  \
  46         README                                          \
  47         ReleaseNotes                                    \
  48         scripts/maint/checkSpace.pl
  49
  50 ## This tells etags how to find mockable function definitions.
  51 AM_ETAGSFLAGS=--regex='{c}/MOCK_IMPL([^,]+,\W*\([a-zA-Z0-9_]+\)\W*,/\1/s'
  52
  53 if COVERAGE_ENABLED
  54 TEST_CFLAGS=-fno-inline -fprofile-arcs -ftest-coverage
  55 if DISABLE_ASSERTS_IN_UNIT_TESTS
  56 TEST_CPPFLAGS=-DTOR_UNIT_TESTS -DTOR_COVERAGE -DDISABLE_ASSERTS_IN_UNIT_TESTS @TOR_MODULES_ALL_ENABLED@
  57 else
  58 TEST_CPPFLAGS=-DTOR_UNIT_TESTS -DTOR_COVERAGE @TOR_MODULES_ALL_ENABLED@
  59 endif
  60 TEST_NETWORK_FLAGS=--coverage --hs-multi-client 1
  61 else
  62 TEST_CFLAGS=
  63 TEST_CPPFLAGS=-DTOR_UNIT_TESTS @TOR_MODULES_ALL_ENABLED@
  64 TEST_NETWORK_FLAGS=--hs-multi-client 1
  65 endif
  66 TEST_NETWORK_WARNING_FLAGS=--quiet --only-warnings
  67
  68 if LIBFUZZER_ENABLED
  69 TEST_CFLAGS += -fsanitize-coverage=trace-pc-guard,trace-cmp,trace-div
  70 # not "edge"
  71 endif
  72
  73 TEST_NETWORK_ALL_LOG_DIR=$(top_builddir)/test_network_log
  74 TEST_NETWORK_ALL_DRIVER_FLAGS=--color-tests yes
  75
  76 #install-data-local:
  77 #       $(INSTALL) -m 755 -d $(LOCALSTATEDIR)/lib/tor
  78
  79 # Allows to override rpmbuild with rpmbuild-md5 from fedora-packager so that
  80 # building for EL5 won't fail on https://bugzilla.redhat.com/show_bug.cgi?id=490613
  81 RPMBUILD ?= rpmbuild
  82
  83 # Use automake's dist-gzip target to build the tarball
  84 dist-rpm: dist-gzip
  85         TIMESTAMP=$$(date +"%Y-%m-%d_%H.%M.%S");                                \
  86         RPM_BUILD_DIR=$$(mktemp -d "/tmp/tor-rpm-build-$$TIMESTAMP-XXXX");      \
  87         mkdir -p "$$RPM_BUILD_DIR"/{BUILD,RPMS,SOURCES/"tor-$(VERSION)",SPECS,SRPMS}; \
  88         cp -fa "$(distdir).tar.gz" "$$RPM_BUILD_DIR"/SOURCES/;                  \
  89         LIBS=-lrt $(RPMBUILD) -ba --define "_topdir $$RPM_BUILD_DIR" tor.spec;  \
  90         cp -fa "$$RPM_BUILD_DIR"/SRPMS/* .;                                     \
  91         cp -fa "$$RPM_BUILD_DIR"/RPMS/* .;                                      \
  92         rm -rf "$$RPM_BUILD_DIR";                                               \
  93         echo "RPM build finished";                                              \
  94         #end of dist-rpm
  95
  96 doxygen:
  97         doxygen && cd doc/doxygen/latex && make
  98
  99 test: all
 100         $(top_builddir)/src/test/test
 101
 102 check-local: check-spaces check-changes
 103
 104 need-chutney-path:
 105         @if test ! -d "$$CHUTNEY_PATH"; then \
 106                 echo '$$CHUTNEY_PATH was not set.'; \
 107                 if test -d $(top_srcdir)/../chutney -a -x $(top_srcdir)/../chutney/chutney; then \
 108                         echo "Assuming test-network.sh will find" $(top_srcdir)/../chutney; \
 109                 else \
 110                         echo; \
 111                         echo "To run these tests, git clone https://git.torproject.org/chutney.git ; export CHUTNEY_PATH=\`pwd\`/chutney"; \
 112                         exit 1; \
 113                 fi \
 114         fi
 115
 116 # Note that test-network requires a copy of Chutney in $CHUTNEY_PATH.
 117 # Chutney can be cloned from https://git.torproject.org/chutney.git .
 118 test-network: need-chutney-path $(TESTING_TOR_BINARY) src/tools/tor-gencert
 119         $(top_srcdir)/src/test/test-network.sh $(TEST_NETWORK_FLAGS)
 120
 121 # Run all available tests using automake's test-driver
 122 # only run IPv6 tests if we can ping6 ::1 (localhost)
 123 # only run IPv6 tests if we can ping ::1 (localhost)
 124 # some IPv6 tests will fail without an IPv6 DNS server (see #16971 and #17011)
 125 # only run mixed tests if we have a tor-stable binary
 126 # Try the syntax for BSD ping6, Linux ping6, and Linux ping -6,
 127 # because they're incompatible
 128 test-network-all: need-chutney-path test-driver $(TESTING_TOR_BINARY) src/tools/tor-gencert
 129         mkdir -p $(TEST_NETWORK_ALL_LOG_DIR)
 130         rm -f $(TEST_NETWORK_ALL_LOG_DIR)/*.log $(TEST_NETWORK_ALL_LOG_DIR)/*.trs
 131         @flavors="$(TEST_CHUTNEY_FLAVORS)"; \
 132         if ping6 -q -c 1 -o ::1 >/dev/null 2>&1 || ping6 -q -c 1 -W 1 ::1 >/dev/null 2>&1 || ping -6 -c 1 -W 1 ::1 >/dev/null 2>&1; then \
 133                 echo "ping6 ::1 or ping ::1 succeeded, running IPv6 flavors: $(TEST_CHUTNEY_FLAVORS_IPV6)."; \
 134                 flavors="$$flavors $(TEST_CHUTNEY_FLAVORS_IPV6)"; \
 135         else \
 136                 echo "ping6 ::1 and ping ::1 failed, skipping IPv6 flavors: $(TEST_CHUTNEY_FLAVORS_IPV6)."; \
 137                 skip_flavors="$$skip_flavors $(TEST_CHUTNEY_FLAVORS_IPV6)"; \
 138         fi; \
 139         if command -v tor-stable >/dev/null 2>&1; then \
 140                 echo "tor-stable found, running mixed flavors: $(TEST_CHUTNEY_FLAVORS_MIXED)."; \
 141                 flavors="$$flavors $(TEST_CHUTNEY_FLAVORS_MIXED)"; \
 142         else \
 143                 echo "tor-stable not found, skipping mixed flavors: $(TEST_CHUTNEY_FLAVORS_MIXED)."; \
 144                 skip_flavors="$$skip_flavors $(TEST_CHUTNEY_FLAVORS_MIXED)"; \
 145         fi; \
 146         for f in $$skip_flavors; do \
 147                 echo "SKIP: $$f"; \
 148         done; \
 149         for f in $$flavors; do \
 150                 $(SHELL) $(top_srcdir)/test-driver --test-name $$f --log-file $(TEST_NETWORK_ALL_LOG_DIR)/$$f.log --trs-file $(TEST_NETWORK_ALL_LOG_DIR)/$$f.trs $(TEST_NETWORK_ALL_DRIVER_FLAGS) $(top_srcdir)/src/test/test-network.sh --flavor $$f $(TEST_NETWORK_FLAGS); \
 151                 $(top_srcdir)/src/test/test-network.sh $(TEST_NETWORK_WARNING_FLAGS); \
 152         done; \
 153         echo "Log and result files are available in $(TEST_NETWORK_ALL_LOG_DIR)."; \
 154         ! grep -q FAIL $(TEST_NETWORK_ALL_LOG_DIR)/*.trs
 155
 156 need-stem-path:
 157         @if test ! -d "$$STEM_SOURCE_DIR"; then \
 158                 echo '$$STEM_SOURCE_DIR was not set.'; echo; \
 159                 echo "To run these tests, git clone https://git.torproject.org/stem.git/ ; export STEM_SOURCE_DIR=\`pwd\`/stem"; \
 160                 exit 1; \
 161         fi
 162
 163 test-stem: need-stem-path $(TESTING_TOR_BINARY)
 164         @$(PYTHON) "$$STEM_SOURCE_DIR"/run_tests.py --tor "$(TESTING_TOR_BINARY)" --all --log notice --target RUN_ALL;
 165
 166 test-stem-full: need-stem-path $(TESTING_TOR_BINARY)
 167         @$(PYTHON) "$$STEM_SOURCE_DIR"/run_tests.py --tor "$(TESTING_TOR_BINARY)" --all --log notice --target RUN_ALL,ONLINE -v;
 168
 169 test-full: need-stem-path need-chutney-path check test-network test-stem
 170
 171 test-full-online: need-stem-path need-chutney-path check test-network test-stem-full
 172
 173 reset-gcov:
 174         rm -f $(top_builddir)/src/*/*.gcda $(top_builddir)/src/*/*/*.gcda
 175
 176 HTML_COVER_DIR=$(top_builddir)/coverage_html
 177 coverage-html: all
 178 if COVERAGE_ENABLED
 179         test -e "`which lcov`" || (echo "lcov must be installed. See <http://ltp.sourceforge.net/coverage/lcov.php>." && false)
 180         test -d "$(HTML_COVER_DIR)" || $(MKDIR_P) "$(HTML_COVER_DIR)"
 181         lcov --rc lcov_branch_coverage=1 --directory $(top_builddir)/src --zerocounters
 182         $(MAKE) reset-gcov
 183         $(MAKE) check
 184         lcov --capture --rc lcov_branch_coverage=1 --no-external --directory $(top_builddir) --base-directory $(top_srcdir) --output-file "$(HTML_COVER_DIR)/lcov.tmp"
 185         lcov --remove "$(HTML_COVER_DIR)/lcov.tmp" --rc lcov_branch_coverage=1 'test/*' 'ext/tinytest*' '/usr/*' --output-file "$(HTML_COVER_DIR)/lcov.info"
 186         genhtml --branch-coverage -o "$(HTML_COVER_DIR)" "$(HTML_COVER_DIR)/lcov.info"
 187 else
 188         @printf "Not configured with --enable-coverage, run ./configure --enable-coverage\n"
 189 endif
 190
 191 coverage-html-full: all
 192         test -e "`which lcov`" || (echo "lcov must be installed. See <http://ltp.sourceforge.net/coverage/lcov.php>." && false)
 193         test -d "$(HTML_COVER_DIR)" || mkdir -p "$(HTML_COVER_DIR)"
 194         lcov --rc lcov_branch_coverage=1 --directory ./src --zerocounters
 195         $(MAKE) reset-gcov
 196         $(MAKE) check
 197         $(MAKE) test-stem-full
 198         CHUTNEY_TOR=tor-cov CHUTNEY_TOR_GENCERT=tor-cov-gencert $(top_srcdir)/src/test/test-network.sh
 199         CHUTNEY_TOR=tor-cov CHUTNEY_TOR_GENCERT=tor-cov-gencert $(top_srcdir)/src/test/test-network.sh --flavor hs
 200         lcov --capture --rc lcov_branch_coverage=1 --no-external --directory . --output-file "$(HTML_COVER_DIR)/lcov.tmp"
 201         lcov --remove "$(HTML_COVER_DIR)/lcov.tmp" --rc lcov_branch_coverage=1 'test/*' 'ext/tinytest*' '/usr/*' --output-file "$(HTML_COVER_DIR)/lcov.info"
 202         genhtml --branch-coverage -o "$(HTML_COVER_DIR)" "$(HTML_COVER_DIR)/lcov.info"
 203
 204 # Avoid strlcpy.c, strlcat.c, aes.c, OpenBSD_malloc_Linux.c, sha256.c,
 205 # tinytest*.[ch]
 206 check-spaces:
 207 if USE_PERL
 208         $(PERL) $(top_srcdir)/scripts/maint/checkSpace.pl -C \
 209                 $(top_srcdir)/src/common/*.[ch] \
 210                 $(top_srcdir)/src/or/*.[ch] \
 211                 $(top_srcdir)/src/test/*.[ch] \
 212                 $(top_srcdir)/src/test/*/*.[ch] \
 213                 $(top_srcdir)/src/tools/*.[ch]
 214 endif
 215
 216 check-docs: all
 217         $(PERL) $(top_builddir)/scripts/maint/checkOptionDocs.pl
 218
 219 check-logs:
 220         $(top_srcdir)/scripts/maint/checkLogs.pl \
 221                 $(top_srcdir)/src/*/*.[ch] | sort -n
 222
 223 .PHONY: check-typos
 224 check-typos:
 225         @if test -x "`which misspell 2>&1;true`"; then \
 226                 echo "Checking for Typos ..."; \
 227                 (misspell \
 228                         $(top_srcdir)/src/[^e]*/*.[ch] \
 229                         $(top_srcdir)/doc \
 230                         $(top_srcdir)/contrib \
 231                         $(top_srcdir)/scripts \
 232                         $(top_srcdir)/README \
 233                         $(top_srcdir)/ChangeLog \
 234                         $(top_srcdir)/INSTALL \
 235                         $(top_srcdir)/ReleaseNotes \
 236                         $(top_srcdir)/LICENSE); \
 237         else \
 238                 echo "Tor can use misspell to check for typos."; \
 239                 echo "It seems that you don't have misspell installed."; \
 240                 echo "You can install the latest version of misspell here: https://github.com/client9/misspell#install"; \
 241         fi
 242
 243 .PHONY: check-changes
 244 check-changes:
 245 if USEPYTHON
 246         @if test -d "$(top_srcdir)/changes"; then \
 247                 $(PYTHON) $(top_srcdir)/scripts/maint/lintChanges.py $(top_srcdir)/changes; \
 248                 fi
 249 endif
 250
 251 .PHONY: update-versions
 252 update-versions:
 253         $(PERL) $(top_builddir)/scripts/maint/updateVersions.pl
 254
 255 .PHONY: callgraph
 256 callgraph:
 257         $(top_builddir)/scripts/maint/run_calltool.sh
 258
 259 version:
 260         @echo "Tor @VERSION@"
 261         @if test -d "$(top_srcdir)/.git" && test -x "`which git 2>&1;true`"; then \
 262            echo -n "git: " ;\
 263            (cd "$(top_srcdir)" && git rev-parse --short=16 HEAD); \
 264         fi
 265
 266 mostlyclean-local:
 267         rm -f $(top_builddir)/src/*/*.gc{da,no} $(top_builddir)/src/*/*/*.gc{da,no}
 268         rm -rf $(HTML_COVER_DIR)
 269         rm -rf $(top_builddir)/doc/doxygen
 270         rm -rf $(TEST_NETWORK_ALL_LOG_DIR)
 271
 272 clean-local:
 273         rm -rf $(top_builddir)/src/rust/target
 274         rm -rf $(top_builddir)/src/rust/.cargo/registry
 275
 276 if USE_RUST
 277 distclean-local: distclean-rust
 278 endif
 279
 280 # This relies on some internal details of how automake implements
 281 # distcheck.  We check two directories because automake-1.15 changed
 282 # from $(distdir)/_build to $(distdir)/_build/sub.
 283 show-distdir-testlog:
 284         @if test -d "$(distdir)/_build/sub"; then \
 285           cat $(distdir)/_build/sub/$(TEST_SUITE_LOG); \
 286         else \
 287           cat $(distdir)/_build/$(TEST_SUITE_LOG); fi