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