Makefile.am

   1 # Copyright (c) 2001-2004, Roger Dingledine
   2 # Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson
   3 # Copyright (c) 2007-2019, 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         -I$(top_srcdir)/src \
  20         -I$(top_srcdir)/src/ext \
  21         -I$(top_srcdir)/src/ext/trunnel \
  22         -I$(top_srcdir)/src/trunnel
  23
  24 AM_CFLAGS=                                      \
  25         @TOR_SYSTEMD_CFLAGS@                    \
  26         @CFLAGS_BUGTRAP@                        \
  27         @TOR_LZMA_CFLAGS@                       \
  28         @TOR_ZSTD_CFLAGS@
  29
  30 SHELL=@SHELL@
  31
  32 if COVERAGE_ENABLED
  33 TESTING_TOR_BINARY=$(top_builddir)/src/app/tor-cov$(EXEEXT)
  34 else
  35 TESTING_TOR_BINARY=$(top_builddir)/src/app/tor$(EXEEXT)
  36 endif
  37
  38 if USE_RUST
  39 rust_ldadd=$(top_builddir)/$(TOR_RUST_LIB_PATH)
  40 else
  41 rust_ldadd=
  42 endif
  43
  44 # "Common" libraries used to link tor's utility code.
  45 TOR_UTIL_LIBS = \
  46         src/lib/libtor-geoip.a \
  47         src/lib/libtor-process.a \
  48         src/lib/libtor-buf.a \
  49         src/lib/libtor-confmgt.a \
  50         src/lib/libtor-pubsub.a \
  51         src/lib/libtor-dispatch.a \
  52         src/lib/libtor-time.a \
  53         src/lib/libtor-fs.a \
  54         src/lib/libtor-encoding.a \
  55         src/lib/libtor-sandbox.a \
  56         src/lib/libtor-container.a \
  57         src/lib/libtor-net.a \
  58         src/lib/libtor-thread.a \
  59         src/lib/libtor-memarea.a \
  60         src/lib/libtor-math.a \
  61         src/lib/libtor-meminfo.a \
  62         src/lib/libtor-osinfo.a \
  63         src/lib/libtor-log.a \
  64         src/lib/libtor-lock.a \
  65         src/lib/libtor-fdio.a \
  66         src/lib/libtor-string.a \
  67         src/lib/libtor-term.a \
  68         src/lib/libtor-smartlist-core.a \
  69         src/lib/libtor-malloc.a \
  70         src/lib/libtor-wallclock.a \
  71         src/lib/libtor-err.a \
  72         src/lib/libtor-version.a \
  73         src/lib/libtor-llharden.a \
  74         src/lib/libtor-intmath.a \
  75         src/lib/libtor-ctime.a
  76
  77 # Variants of the above for linking the testing variant of tor (for coverage
  78 # and tests)
  79 if UNITTESTS_ENABLED
  80 TOR_UTIL_TESTING_LIBS = \
  81         src/lib/libtor-geoip-testing.a \
  82         src/lib/libtor-process-testing.a \
  83         src/lib/libtor-buf-testing.a \
  84         src/lib/libtor-confmgt-testing.a \
  85         src/lib/libtor-pubsub-testing.a \
  86         src/lib/libtor-dispatch-testing.a \
  87         src/lib/libtor-time-testing.a \
  88         src/lib/libtor-fs-testing.a \
  89         src/lib/libtor-encoding-testing.a \
  90         src/lib/libtor-sandbox-testing.a \
  91         src/lib/libtor-container-testing.a \
  92         src/lib/libtor-net-testing.a \
  93         src/lib/libtor-thread-testing.a \
  94         src/lib/libtor-memarea-testing.a \
  95         src/lib/libtor-math-testing.a \
  96         src/lib/libtor-meminfo-testing.a \
  97         src/lib/libtor-osinfo-testing.a \
  98         src/lib/libtor-term-testing.a \
  99         src/lib/libtor-log-testing.a \
 100         src/lib/libtor-lock-testing.a \
 101         src/lib/libtor-fdio-testing.a \
 102         src/lib/libtor-string-testing.a \
 103         src/lib/libtor-smartlist-core-testing.a \
 104         src/lib/libtor-malloc-testing.a \
 105         src/lib/libtor-wallclock-testing.a \
 106         src/lib/libtor-err-testing.a \
 107         src/lib/libtor-version-testing.a \
 108         src/lib/libtor-llharden-testing.a \
 109         src/lib/libtor-intmath.a \
 110         src/lib/libtor-ctime-testing.a
 111 endif
 112
 113 # Internal crypto libraries used in Tor
 114 TOR_CRYPTO_LIBS = \
 115         src/lib/libtor-tls.a \
 116         src/lib/libtor-crypt-ops.a \
 117         $(LIBKECCAK_TINY) \
 118         $(LIBDONNA)
 119
 120 # Variants of the above for linking the testing variant of tor (for coverage
 121 # and tests)
 122 if UNITTESTS_ENABLED
 123 TOR_CRYPTO_TESTING_LIBS = \
 124         src/lib/libtor-tls-testing.a \
 125         src/lib/libtor-crypt-ops-testing.a \
 126         $(LIBKECCAK_TINY) \
 127         $(LIBDONNA)
 128 endif
 129
 130 # All static libraries used to link tor.
 131 TOR_INTERNAL_LIBS = \
 132         src/core/libtor-app.a \
 133         src/lib/libtor-compress.a \
 134         src/lib/libtor-evloop.a \
 135         $(TOR_CRYPTO_LIBS) \
 136         $(TOR_UTIL_LIBS) \
 137         src/trunnel/libor-trunnel.a \
 138         src/lib/libtor-trace.a
 139
 140 # Variants of the above for linking the testing variant of tor (for coverage
 141 # and tests)
 142 if UNITTESTS_ENABLED
 143 TOR_INTERNAL_TESTING_LIBS = \
 144         src/core/libtor-app-testing.a \
 145         src/lib/libtor-compress-testing.a \
 146         src/lib/libtor-evloop-testing.a \
 147         $(TOR_CRYPTO_TESTING_LIBS) \
 148         $(TOR_UTIL_TESTING_LIBS) \
 149         src/trunnel/libor-trunnel-testing.a \
 150         src/lib/libtor-trace.a
 151 endif
 152
 153 TOR_LDFLAGS_CRYPTLIB=@TOR_LDFLAGS_openssl@
 154 TOR_LIBS_CRYPTLIB=@TOR_OPENSSL_LIBS@
 155 TOR_CFLAGS_CRYPTLIB=
 156 if USE_NSS
 157 TOR_CFLAGS_CRYPTLIB+=@NSS_CFLAGS@
 158 TOR_LIBS_CRYPTLIB+=@NSS_LIBS@
 159 endif
 160
 161 # All libraries used to link tor-cov
 162
 163 include src/include.am
 164 include doc/include.am
 165 include contrib/include.am
 166
 167 EXTRA_DIST+= \
 168         ChangeLog                                                       \
 169         CONTRIBUTING                                                    \
 170         CODE_OF_CONDUCT                                                 \
 171         INSTALL                                                         \
 172         LICENSE                                                         \
 173         Makefile.nmake                                                  \
 174         README                                                          \
 175         ReleaseNotes                                                    \
 176         scripts/maint/checkIncludes.py                                  \
 177         scripts/maint/checkSpace.pl                                     \
 178         scripts/maint/checkSpaceTest.sh                                 \
 179         scripts/maint/checkspace_tests/dubious.c                        \
 180         scripts/maint/checkspace_tests/dubious.h                        \
 181         scripts/maint/checkspace_tests/expected.txt                     \
 182         scripts/maint/checkspace_tests/good_guard.h                     \
 183         scripts/maint/checkspace_tests/same_guard.h                     \
 184         scripts/maint/checkspace_tests/subdir/dubious.c                 \
 185         scripts/maint/checkShellScripts.sh                              \
 186         scripts/maint/practracker/README                                \
 187         scripts/maint/practracker/exceptions.txt                        \
 188         scripts/maint/practracker/includes.py                           \
 189         scripts/maint/practracker/metrics.py                            \
 190         scripts/maint/practracker/practracker.py                        \
 191         scripts/maint/practracker/practracker_tests.py                  \
 192         scripts/maint/practracker/problem.py                            \
 193         scripts/maint/practracker/testdata/.may_include                 \
 194         scripts/maint/practracker/testdata/a.c                          \
 195         scripts/maint/practracker/testdata/b.c                          \
 196         scripts/maint/practracker/testdata/ex0-expected.txt             \
 197         scripts/maint/practracker/testdata/ex0.txt                      \
 198         scripts/maint/practracker/testdata/ex1-expected.txt             \
 199         scripts/maint/practracker/testdata/ex1.txt                      \
 200         scripts/maint/practracker/testdata/ex1-overbroad-expected.txt   \
 201         scripts/maint/practracker/testdata/ex1-regen-expected.txt       \
 202         scripts/maint/practracker/testdata/ex1-regen-overbroad-expected.txt \
 203         scripts/maint/practracker/testdata/ex.txt                       \
 204         scripts/maint/practracker/testdata/header.h                     \
 205         scripts/maint/practracker/testdata/not_c_file                   \
 206         scripts/maint/practracker/test_practracker.sh                   \
 207         scripts/maint/practracker/util.py                               \
 208         scripts/coccinelle/apply.sh                                     \
 209         scripts/coccinelle/check_cocci_parse.sh                         \
 210         scripts/coccinelle/exceptions.txt                               \
 211         scripts/coccinelle/test-operator-cleanup                        \
 212         scripts/coccinelle/tor-coccinelle.h                             \
 213         scripts/coccinelle/try_parse.sh
 214
 215 ## This tells etags how to find mockable function definitions.
 216 AM_ETAGSFLAGS=--regex='{c}/MOCK_IMPL([^,]+,\W*\([a-zA-Z0-9_]+\)\W*,/\1/s'
 217
 218 if COVERAGE_ENABLED
 219 TEST_CFLAGS=-fno-inline -fprofile-arcs -ftest-coverage
 220 if DISABLE_ASSERTS_IN_UNIT_TESTS
 221 TEST_CPPFLAGS=-DTOR_UNIT_TESTS -DTOR_COVERAGE -DDISABLE_ASSERTS_IN_UNIT_TESTS @TOR_MODULES_ALL_ENABLED@
 222 else
 223 TEST_CPPFLAGS=-DTOR_UNIT_TESTS -DTOR_COVERAGE @TOR_MODULES_ALL_ENABLED@
 224 endif
 225 TEST_NETWORK_FLAGS=--coverage --hs-multi-client 1
 226 else
 227 TEST_CFLAGS=
 228 TEST_CPPFLAGS=-DTOR_UNIT_TESTS @TOR_MODULES_ALL_ENABLED@
 229 TEST_NETWORK_FLAGS=--hs-multi-client 1
 230 endif
 231 TEST_NETWORK_SHOW_WARNINGS_FOR_LAST_RUN_FLAGS=--quiet --only-warnings
 232
 233 if LIBFUZZER_ENABLED
 234 TEST_CFLAGS += -fsanitize-coverage=trace-pc-guard,trace-cmp,trace-div
 235 # not "edge"
 236 endif
 237
 238 TEST_NETWORK_ALL_LOG_DIR=$(top_builddir)/test_network_log
 239 TEST_NETWORK_ALL_DRIVER_FLAGS=--color-tests yes
 240
 241 #install-data-local:
 242 #       $(INSTALL) -m 755 -d $(LOCALSTATEDIR)/lib/tor
 243
 244 # Allows to override rpmbuild with rpmbuild-md5 from fedora-packager so that
 245 # building for EL5 won't fail on https://bugzilla.redhat.com/show_bug.cgi?id=490613
 246 RPMBUILD ?= rpmbuild
 247
 248 # Use automake's dist-gzip target to build the tarball
 249 dist-rpm: dist-gzip
 250         TIMESTAMP=$$(date +"%Y-%m-%d_%H.%M.%S");                                \
 251         RPM_BUILD_DIR=$$(mktemp -d "/tmp/tor-rpm-build-$$TIMESTAMP-XXXX");      \
 252         mkdir -p "$$RPM_BUILD_DIR"/{BUILD,RPMS,SOURCES/"tor-$(VERSION)",SPECS,SRPMS}; \
 253         cp -fa "$(distdir).tar.gz" "$$RPM_BUILD_DIR"/SOURCES/;                  \
 254         LIBS=-lrt $(RPMBUILD) -ba --define "_topdir $$RPM_BUILD_DIR" tor.spec;  \
 255         cp -fa "$$RPM_BUILD_DIR"/SRPMS/* .;                                     \
 256         cp -fa "$$RPM_BUILD_DIR"/RPMS/* .;                                      \
 257         rm -rf "$$RPM_BUILD_DIR";                                               \
 258         echo "RPM build finished";                                              \
 259         #end of dist-rpm
 260
 261 .PHONY: doxygen
 262 doxygen: Doxyfile
 263         mkdir -p doc/doxygen
 264         (cd "$(top_srcdir)" && doxygen "$(abs_top_builddir)/Doxyfile")
 265
 266 test: all
 267         $(top_builddir)/src/test/test
 268
 269 shellcheck:
 270         $(top_srcdir)/scripts/maint/checkShellScripts.sh
 271
 272 check-local:                                    \
 273         check-spaces                            \
 274         check-changes                           \
 275         check-includes                          \
 276         check-best-practices                    \
 277         shellcheck                              \
 278         check-cocci
 279
 280 # test-network requires a copy of Chutney in $CHUTNEY_PATH.
 281 # Chutney can be cloned from https://git.torproject.org/chutney.git .
 282 .PHONY: need-chutney-path
 283 need-chutney-path:
 284         @if test ! -d "$$CHUTNEY_PATH"; then \
 285                 echo '$$CHUTNEY_PATH was not set.'; \
 286                 if test -d "$(top_srcdir)/../chutney" && \
 287                    test -x "$(top_srcdir)/../chutney/chutney"; then \
 288                         echo "Assuming test-network.sh will find" \
 289                           "$(top_srcdir)/../chutney"; \
 290                 else \
 291                         echo; \
 292                         echo "To run these tests," \
 293                           "git clone" \
 294                           "https://git.torproject.org/chutney.git ;" \
 295                           "export CHUTNEY_PATH=\`pwd\`/chutney"; \
 296                         exit 1; \
 297                 fi \
 298         fi
 299
 300 # Run some basic tests using automake's test-driver
 301 .PHONY: test-network
 302 # Hide directory path logs from submakes using $(MAKE) -s
 303 test-network:
 304         @$(MAKE) -s test-network-mkdir
 305         @$(MAKE) -s test-network-clean
 306         @$(MAKE) -s test-network-run \
 307           ipv4_flavors="$(TEST_CHUTNEY_FLAVOR_QUICK)" \
 308           ipv6_flavors="$(TEST_CHUTNEY_FLAVOR_QUICK_IPV6)"
 309         @$(MAKE) -s test-network-results
 310
 311 # Run all available tests using automake's test-driver
 312 .PHONY: test-network-all
 313 # Hide directory path logs from submakes using $(MAKE) -s
 314 test-network-all:
 315         @$(MAKE) -s test-network-mkdir
 316         @$(MAKE) -s test-network-clean
 317         @$(MAKE) -s test-network-run \
 318           ipv4_flavors="$(TEST_CHUTNEY_FLAVORS)" \
 319           mixed_flavors="$(TEST_CHUTNEY_FLAVORS_MIXED)" \
 320           ipv6_flavors="$(TEST_CHUTNEY_FLAVORS_IPV6)" \
 321           ipv6_mixed_flavors="$(TEST_CHUTNEY_FLAVORS_IPV6_MIXED)"
 322         @$(MAKE) -s test-network-results
 323
 324 # Run IPv4 and mixed tests using automake's test-driver
 325 .PHONY: test-network-ipv4
 326 # Hide directory path logs from submakes using $(MAKE) -s
 327 test-network-ipv4:
 328         @$(MAKE) -s test-network-mkdir
 329         @$(MAKE) -s test-network-clean
 330         @$(MAKE) -s test-network-run \
 331           ipv4_flavors="$(TEST_CHUTNEY_FLAVORS)" \
 332           mixed_flavors="$(TEST_CHUTNEY_FLAVORS_MIXED)"
 333         @$(MAKE) -s test-network-results
 334
 335 # Run IPv6 tests using automake's test-driver
 336 .PHONY: test-network-ipv6
 337 # Hide directory path logs from submakes using $(MAKE) -s
 338 test-network-ipv6:
 339         @$(MAKE) -s test-network-mkdir
 340         @$(MAKE) -s test-network-clean
 341         @$(MAKE) -s test-network-run \
 342           ipv6_flavors="$(TEST_CHUTNEY_FLAVORS_IPV6)" \
 343           ipv6_mixed_flavors="$(TEST_CHUTNEY_FLAVORS_IPV6_MIXED)"
 344         @$(MAKE) -s test-network-results
 345
 346 # Make the test network log directory, if it does not exist
 347 .PHONY: test-network-mkdir
 348 test-network-mkdir:
 349         @mkdir -p "$(TEST_NETWORK_ALL_LOG_DIR)"
 350
 351 # Clean the test network log directory
 352 .PHONY: test-network-clean
 353 # We need to remove all matching files, so we can't quote the glob part of the
 354 # rm arguments
 355 test-network-clean:
 356         rm -f "$(TEST_NETWORK_ALL_LOG_DIR)"/*.log \
 357               "$(TEST_NETWORK_ALL_LOG_DIR)"/*.trs
 358
 359 # Run tests using automake's test-driver
 360 # When checking if a set of test can be run, log the type of test, and the
 361 # list of tests that will be run (or skipped).
 362 #
 363 # Run the IPv4 tests in $(ipv4_flavors), unconditionally
 364 #   - tor relays and directory authorities require IPv4.
 365 # Run the IPv6 tests in $(ipv6_flavors), if IPv6 is available
 366 #   - only run IPv6 tests if we can ping6 or ping -6 ::1 (localhost)
 367 #     we try the syntax for BSD ping6, Linux ping6, and Linux ping -6,
 368 #     because they're incompatible
 369 #   - some IPv6 tests may fail without an IPv6 DNS server
 370 #     (see #16971 and #17011)
 371 # Run the mixed tests in $(mixed_flavors), if a tor-stable binary is available
 372 #   - only run mixed tests if we have a tor-stable binary
 373 # Run the IPv6 mixed tests in $(ipv6_mixed_flavors), if IPv6 and mixed are run
 374 #   - see above for details about IPv6 and mixed
 375 .PHONY: test-network-run
 376 # We need the word splitting in the "for" lines, so we can't quote
 377 # $(skip_flavors) or $(flavors)
 378 test-network-run: need-chutney-path test-driver $(TESTING_TOR_BINARY) src/tools/tor-gencert
 379         @flavors=""; \
 380         skip_flavors=""; \
 381         if test -n "$(ipv4_flavors)"; then \
 382                 echo "Running IPv4 flavors: $(ipv4_flavors)."; \
 383                 flavors="$$flavors $(ipv4_flavors)"; \
 384         fi; \
 385         test_network_ipv6=false; \
 386         if test -n "$(ipv6_flavors)" || \
 387            test -n "$(ipv6_mixed_flavors)"; then \
 388                 if ping6 -q -c 1 -o   ::1 >/dev/null 2>&1 || \
 389                    ping6 -q -c 1 -W 1 ::1 >/dev/null 2>&1 || \
 390                    ping  -6 -c 1 -W 1 ::1 >/dev/null 2>&1; then \
 391                         test_network_ipv6=true; \
 392                 fi; \
 393         fi; \
 394         if test -n "$(ipv6_flavors)"; then \
 395                 if test "$$test_network_ipv6" = "true"; then \
 396                         echo "ping6 ::1 or ping ::1 succeeded, running IPv6" \
 397                           "flavors: $(ipv6_flavors)."; \
 398                         flavors="$$flavors $(ipv6_flavors)"; \
 399                 else \
 400                         echo "ping6 ::1 and ping ::1 failed, skipping IPv6" \
 401                           "flavors: $(ipv6_flavors)."; \
 402                         skip_flavors="$$skip_flavors $(ipv6_flavors)"; \
 403                 fi; \
 404         fi; \
 405         test_network_mixed=false; \
 406         if test -n "$(mixed_flavors)" || \
 407            test -n "$(ipv6_mixed_flavors)"; then \
 408                 if command -v tor-stable >/dev/null 2>&1; then \
 409                         test_network_mixed=true; \
 410                 fi; \
 411         fi; \
 412         if test -n "$(mixed_flavors)"; then \
 413                 if test "$$test_network_mixed" = "true"; then \
 414                         echo "tor-stable found, running mixed flavors:" \
 415                           "$(mixed_flavors)."; \
 416                         flavors="$$flavors $(mixed_flavors)"; \
 417                 else \
 418                         echo "tor-stable not found, skipping mixed flavors:" \
 419                           "$(mixed_flavors)."; \
 420                         skip_flavors="$$skip_flavors $(mixed_flavors)"; \
 421                 fi; \
 422         fi; \
 423         if test -n "$(ipv6_mixed_flavors)"; then \
 424                 if test "$$test_network_ipv6" = "true" && \
 425                    test "$$test_network_mixed" = "true"; then \
 426                         echo "Running IPv6 mixed flavors:" \
 427                           "$(ipv6_mixed_flavors)."; \
 428                         flavors="$$flavors $(ipv6_mixed_flavors)"; \
 429                 else \
 430                         echo "Skipping IPv6 mixed flavors:" \
 431                           "$(ipv6_mixed_flavors)."; \
 432                         skip_flavors="$$skip_flavors $(ipv6_mixed_flavors)"; \
 433                 fi; \
 434         fi; \
 435         for f in $$skip_flavors; do \
 436                 echo "SKIP: $$f"; \
 437         done; \
 438         for f in $$flavors; do \
 439                 $(SHELL) "$(top_srcdir)/test-driver" --test-name "$$f" \
 440                   --log-file "$(TEST_NETWORK_ALL_LOG_DIR)/$$f.log" \
 441                   --trs-file "$(TEST_NETWORK_ALL_LOG_DIR)/$$f.trs" \
 442                   $(TEST_NETWORK_ALL_DRIVER_FLAGS) \
 443                   "$(top_srcdir)/src/test/test-network.sh" \
 444                     --flavor "$$f" $(TEST_NETWORK_FLAGS); \
 445                 "$(top_srcdir)/src/test/test-network.sh" \
 446                   $(TEST_NETWORK_SHOW_WARNINGS_FOR_LAST_RUN_FLAGS); \
 447         done
 448
 449 # Print the results from automake's test-driver
 450 #   - show tor warnings on the console after each network run
 451 #     (otherwise, warnings go to the logs, and people don't see them unless
 452 #     there is a network failure)
 453 .PHONY: test-network-results
 454 # We need to grep all matching files, so we can't quote the glob part of the
 455 # grep arguments
 456 test-network-results:
 457         @echo \
 458           "Log and result files are available in $(TEST_NETWORK_ALL_LOG_DIR)."
 459         @! grep -q FAIL "$(TEST_NETWORK_ALL_LOG_DIR)"/*.trs
 460
 461 need-stem-path:
 462         @if test ! -d "$$STEM_SOURCE_DIR"; then \
 463                 echo '$$STEM_SOURCE_DIR was not set.'; echo; \
 464                 echo "To run these tests, git clone https://git.torproject.org/stem.git/ ; export STEM_SOURCE_DIR=\`pwd\`/stem"; \
 465                 exit 1; \
 466         fi
 467
 468 test-stem: need-stem-path $(TESTING_TOR_BINARY)
 469         @$(PYTHON) "$$STEM_SOURCE_DIR"/run_tests.py --tor "$(TESTING_TOR_BINARY)" --integ --test control.controller --test control.base_controller --test process --log notice;
 470
 471 test-stem-full: need-stem-path $(TESTING_TOR_BINARY)
 472         @$(PYTHON) "$$STEM_SOURCE_DIR"/run_tests.py --tor "$(TESTING_TOR_BINARY)" --all --log notice --target RUN_ALL,ONLINE -v;
 473
 474 test-full:                                      \
 475         need-stem-path                          \
 476         need-chutney-path                       \
 477         check                                   \
 478         test-network                            \
 479         test-stem
 480
 481 test-full-online:                               \
 482         need-stem-path                          \
 483         need-chutney-path                       \
 484         check                                   \
 485         test-network                            \
 486         test-stem-full
 487
 488 # We can't delete the gcno files, because they are created when tor is compiled
 489 reset-gcov:
 490         rm -f $(top_builddir)/src/*/*.gcda $(top_builddir)/src/*/*/*.gcda \
 491               $(top_builddir)/src/*/*.gcov $(top_builddir)/src/*/*/*.gcov
 492
 493 HTML_COVER_DIR=$(top_builddir)/coverage_html
 494 coverage-html: all
 495 if COVERAGE_ENABLED
 496         test -e "`which lcov`" || (echo "lcov must be installed. See <http://ltp.sourceforge.net/coverage/lcov.php>." && false)
 497         test -d "$(HTML_COVER_DIR)" || $(MKDIR_P) "$(HTML_COVER_DIR)"
 498         lcov --rc lcov_branch_coverage=1 --directory $(top_builddir)/src --zerocounters
 499         $(MAKE) reset-gcov
 500         $(MAKE) check
 501         lcov --capture --rc lcov_branch_coverage=1 --no-external --directory $(top_builddir) --base-directory $(top_srcdir) --output-file "$(HTML_COVER_DIR)/lcov.tmp"
 502         lcov --remove "$(HTML_COVER_DIR)/lcov.tmp" --rc lcov_branch_coverage=1 'test/*' 'ext/tinytest*' '/usr/*' --output-file "$(HTML_COVER_DIR)/lcov.info"
 503         genhtml --branch-coverage -o "$(HTML_COVER_DIR)" "$(HTML_COVER_DIR)/lcov.info"
 504 else
 505         @printf "Not configured with --enable-coverage, run ./configure --enable-coverage\n"
 506 endif
 507
 508 coverage-html-full: all
 509         test -e "`which lcov`" || (echo "lcov must be installed. See <http://ltp.sourceforge.net/coverage/lcov.php>." && false)
 510         test -d "$(HTML_COVER_DIR)" || mkdir -p "$(HTML_COVER_DIR)"
 511         lcov --rc lcov_branch_coverage=1 --directory ./src --zerocounters
 512         $(MAKE) reset-gcov
 513         $(MAKE) check
 514         $(MAKE) test-stem-full
 515         CHUTNEY_TOR=tor-cov CHUTNEY_TOR_GENCERT=tor-cov-gencert $(top_srcdir)/src/test/test-network.sh
 516         CHUTNEY_TOR=tor-cov CHUTNEY_TOR_GENCERT=tor-cov-gencert $(top_srcdir)/src/test/test-network.sh --flavor hs
 517         lcov --capture --rc lcov_branch_coverage=1 --no-external --directory . --output-file "$(HTML_COVER_DIR)/lcov.tmp"
 518         lcov --remove "$(HTML_COVER_DIR)/lcov.tmp" --rc lcov_branch_coverage=1 'test/*' 'ext/tinytest*' '/usr/*' --output-file "$(HTML_COVER_DIR)/lcov.info"
 519         genhtml --branch-coverage -o "$(HTML_COVER_DIR)" "$(HTML_COVER_DIR)/lcov.info"
 520
 521 # For scripts: avoid src/ext and src/trunnel.
 522 # Keep these lists consistent:
 523 #   - OWNED_TOR_C_FILES in Makefile.am
 524 #   - CHECK_FILES in pre-commit.git-hook and pre-push.git-hook
 525 #   - try_parse in check_cocci_parse.sh
 526 OWNED_TOR_C_FILES=\
 527                 $(top_srcdir)/src/lib/*/*.[ch] \
 528                 $(top_srcdir)/src/core/*/*.[ch] \
 529                 $(top_srcdir)/src/feature/*/*.[ch] \
 530                 $(top_srcdir)/src/app/*/*.[ch] \
 531                 $(top_srcdir)/src/test/*.[ch] \
 532                 $(top_srcdir)/src/test/*/*.[ch] \
 533                 $(top_srcdir)/src/tools/*.[ch]
 534
 535 check-spaces:
 536 if USE_PERL
 537         $(PERL) $(top_srcdir)/scripts/maint/checkSpace.pl -C \
 538                 $(OWNED_TOR_C_FILES)
 539 endif
 540
 541 check-includes:
 542 if USEPYTHON
 543         $(PYTHON) $(top_srcdir)/scripts/maint/practracker/includes.py $(top_srcdir)
 544 endif
 545
 546 check-best-practices:
 547 if USEPYTHON
 548         @$(PYTHON) $(top_srcdir)/scripts/maint/practracker/practracker.py $(top_srcdir) $(TOR_PRACTRACKER_OPTIONS)
 549 endif
 550
 551 check-cocci:
 552         VERBOSE=1 $(top_srcdir)/scripts/coccinelle/check_cocci_parse.sh $(OWNED_TOR_C_FILES)
 553
 554 practracker-regen:
 555         $(PYTHON) $(top_srcdir)/scripts/maint/practracker/practracker.py --regen $(top_srcdir)
 556
 557 check-docs: all
 558         $(PERL) $(top_builddir)/scripts/maint/checkOptionDocs.pl
 559
 560 check-logs:
 561         $(top_srcdir)/scripts/maint/checkLogs.pl \
 562                 $(top_srcdir)/src/*/*.[ch] | sort -n
 563
 564 .PHONY: check-typos
 565 check-typos:
 566         @if test -x "`which misspell 2>&1;true`"; then \
 567                 echo "Checking for Typos ..."; \
 568                 (misspell \
 569                         $(top_srcdir)/src/[^e]*/*.[ch] \
 570                         $(top_srcdir)/doc \
 571                         $(top_srcdir)/contrib \
 572                         $(top_srcdir)/scripts \
 573                         $(top_srcdir)/README \
 574                         $(top_srcdir)/ChangeLog \
 575                         $(top_srcdir)/INSTALL \
 576                         $(top_srcdir)/ReleaseNotes \
 577                         $(top_srcdir)/LICENSE); \
 578         else \
 579                 echo "Tor can use misspell to check for typos."; \
 580                 echo "It seems that you don't have misspell installed."; \
 581                 echo "You can install the latest version of misspell here: https://github.com/client9/misspell#install"; \
 582         fi
 583
 584 .PHONY: rustfmt
 585 rustfmt:
 586 if USE_RUST
 587         @if test -x "`which cargo-fmt 2>&1;true`"; then \
 588                 echo "Formatting Rust code ..."; \
 589                 (cd "$(top_srcdir)/src/rust" && cargo fmt --all --); \
 590         else \
 591                 echo "Tor uses rustfmt (via cargo-fmt) to format Rust code."; \
 592                 echo "However, it seems that you don't have rustfmt installed."; \
 593                 printf "You can install rustfmt by following the directions here:"; \
 594                 echo " https://github.com/rust-lang-nursery/rustfmt"; \
 595         fi
 596 endif
 597
 598 .PHONY: check-rustfmt
 599 check-rustfmt:
 600 if USE_RUST
 601         @if test -x "`which cargo-fmt 2>&1;true`"; then \
 602                 printf "Running rustfmt..."; \
 603                 (cd "$(top_srcdir)/src/rust" && cargo fmt --all -- --check && echo "done.") || \
 604                 (echo "**************** check-rustfmt failed. ****************"; \
 605                  echo "   Run \`make rustfmt\` to apply the above changes."; \
 606                  exit 1); \
 607         else \
 608                 echo "Tor uses rustfmt (via cargo-fmt) to format Rust code."; \
 609                 echo "However, it seems that you don't have rustfmt installed."; \
 610                 printf "You can install rustfmt by following the directions here:"; \
 611                 echo " https://github.com/rust-lang-nursery/rustfmt"; \
 612         fi
 613 endif
 614
 615 .PHONY: clippy
 616 clippy:
 617 if USE_RUST
 618         @if test -x "`which cargo-clippy 2>&1;true`"; then \
 619                 echo "Running cargo clippy ..."; \
 620                 echo "Prepare yourself for the onslaught of suggestions ..."; \
 621                 (cd "$(top_srcdir)/src/rust" && cargo clippy); \
 622         else \
 623                 echo "Tor can use clippy to lint Rust code."; \
 624                 echo "However, it seems that you don't have clippy installed."; \
 625                 echo "You can install the latest version of clippy by following the directions here: https://github.com/rust-lang-nursery/rust-clippy"; \
 626         fi
 627 endif
 628
 629 .PHONY: check-changes
 630 check-changes:
 631 if USEPYTHON
 632         @if test -d "$(top_srcdir)/changes"; then \
 633                 PACKAGE_VERSION=$(PACKAGE_VERSION) $(PYTHON) $(top_srcdir)/scripts/maint/lintChanges.py $(top_srcdir)/changes; \
 634                 fi
 635 endif
 636
 637 .PHONY: update-versions
 638 update-versions:
 639         abs_top_srcdir="$(abs_top_srcdir)" $(PYTHON) $(top_srcdir)/scripts/maint/update_versions.py
 640
 641 .PHONY: callgraph
 642 callgraph:
 643         cd $(top_builddir); $(abs_top_srcdir)/scripts/maint/run_calltool.sh
 644
 645 version:
 646         @echo "Tor @VERSION@"
 647         @if test -d "$(top_srcdir)/.git" && test -x "`which git 2>&1;true`"; then \
 648            echo -n "git: " ;\
 649            (cd "$(top_srcdir)" && git rev-parse --short=16 HEAD); \
 650         fi
 651
 652 .PHONY: autostyle-ifdefs
 653 autostyle-ifdefs:
 654         $(PYTHON) $(top_srcdir)/scripts/maint/annotate_ifdef_directives.py $(OWNED_TOR_C_FILES)
 655
 656 .PHONY: autostyle-ifdefs
 657 autostyle-operators:
 658         $(PERL) $(top_srcdir)/scripts/coccinelle/test-operator-cleanup $(OWNED_TOR_C_FILES)
 659
 660 .PHONY: rectify-includes
 661 rectify-includes:
 662         cd $(top_srcdir); $(PYTHON) $(abs_top_srcdir)/scripts/maint/rectify_include_paths.py
 663
 664 .PHONY: update-copyright
 665 update-copyright:
 666         $(PERL) $(top_srcdir)/scripts/maint/updateCopyright.pl $(OWNED_TOR_C_FILES)
 667
 668 .PHONY: autostyle
 669 autostyle: update-versions rustfmt autostyle-ifdefs rectify-includes
 670
 671 mostlyclean-local:
 672         rm -f $(top_builddir)/src/*/*.gc{da,no} $(top_builddir)/src/*/*/*.gc{da,no}
 673         rm -rf $(HTML_COVER_DIR)
 674         rm -rf $(top_builddir)/doc/doxygen
 675         rm -rf $(TEST_NETWORK_ALL_LOG_DIR)
 676
 677 clean-local:
 678         rm -rf $(top_builddir)/src/rust/target
 679         rm -rf $(top_builddir)/src/rust/.cargo/registry
 680
 681 if USE_RUST
 682 distclean-local: distclean-rust
 683 endif
 684
 685 # This relies on some internal details of how automake implements
 686 # distcheck.  We check two directories because automake-1.15 changed
 687 # from $(distdir)/_build to $(distdir)/_build/sub.
 688 show-distdir-testlog:
 689         @if test -d "$(distdir)/_build/sub"; then \
 690           cat $(distdir)/_build/sub/$(TEST_SUITE_LOG); \
 691         else \
 692           cat $(distdir)/_build/$(TEST_SUITE_LOG); fi
 693
 694 # Similarly, this relies on automake internals to run file on an
 695 # intermittent core file whose provenance is not known to us.  See
 696 # ticket 26787.
 697 show-distdir-core:
 698         @if test -d "$(distdir)/_build/sub"; then \
 699           file $(distdir)/_build/sub/core ; \
 700         else \
 701           file $(distdir)/_build/core; fi
 702
 703 show-libs:
 704         @echo $(TOR_INTERNAL_LIBS)
 705
 706 show-testing-libs:
 707         @echo $(TOR_INTERNAL_TESTING_LIBS)