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