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
6 ACLOCAL_AMFLAGS = -I m4
20 -I$(top_srcdir)/src/ext \
21 -I$(top_srcdir)/src/ext/trunnel \
22 -I$(top_srcdir)/src/trunnel
24 AM_CFLAGS=@TOR_SYSTEMD_CFLAGS@ @CFLAGS_BUGTRAP@ @TOR_LZMA_CFLAGS@ @TOR_ZSTD_CFLAGS@
28 TESTING_TOR_BINARY=$(top_builddir)/src/app/tor-cov$(EXEEXT)
30 TESTING_TOR_BINARY=$(top_builddir)/src/app/tor$(EXEEXT)
34 rust_ldadd=$(top_builddir)/$(TOR_RUST_LIB_PATH)
39 # "Common" libraries used to link tor's utility code.
41 src/lib/libtor-geoip.a \
42 src/lib/libtor-process.a \
43 src/lib/libtor-buf.a \
44 src/lib/libtor-pubsub.a \
45 src/lib/libtor-dispatch.a \
46 src/lib/libtor-time.a \
48 src/lib/libtor-encoding.a \
49 src/lib/libtor-sandbox.a \
50 src/lib/libtor-container.a \
51 src/lib/libtor-net.a \
52 src/lib/libtor-thread.a \
53 src/lib/libtor-memarea.a \
54 src/lib/libtor-math.a \
55 src/lib/libtor-meminfo.a \
56 src/lib/libtor-osinfo.a \
57 src/lib/libtor-log.a \
58 src/lib/libtor-lock.a \
59 src/lib/libtor-fdio.a \
60 src/lib/libtor-string.a \
61 src/lib/libtor-term.a \
62 src/lib/libtor-smartlist-core.a \
63 src/lib/libtor-malloc.a \
64 src/lib/libtor-wallclock.a \
65 src/lib/libtor-err.a \
66 src/lib/libtor-version.a \
67 src/lib/libtor-intmath.a \
68 src/lib/libtor-ctime.a
70 # Variants of the above for linking the testing variant of tor (for coverage
73 TOR_UTIL_TESTING_LIBS = \
74 src/lib/libtor-geoip-testing.a \
75 src/lib/libtor-process-testing.a \
76 src/lib/libtor-buf-testing.a \
77 src/lib/libtor-pubsub-testing.a \
78 src/lib/libtor-dispatch-testing.a \
79 src/lib/libtor-time-testing.a \
80 src/lib/libtor-fs-testing.a \
81 src/lib/libtor-encoding-testing.a \
82 src/lib/libtor-sandbox-testing.a \
83 src/lib/libtor-container-testing.a \
84 src/lib/libtor-net-testing.a \
85 src/lib/libtor-thread-testing.a \
86 src/lib/libtor-memarea-testing.a \
87 src/lib/libtor-math-testing.a \
88 src/lib/libtor-meminfo-testing.a \
89 src/lib/libtor-osinfo-testing.a \
90 src/lib/libtor-term-testing.a \
91 src/lib/libtor-log-testing.a \
92 src/lib/libtor-lock-testing.a \
93 src/lib/libtor-fdio-testing.a \
94 src/lib/libtor-string-testing.a \
95 src/lib/libtor-smartlist-core-testing.a \
96 src/lib/libtor-malloc-testing.a \
97 src/lib/libtor-wallclock-testing.a \
98 src/lib/libtor-err-testing.a \
99 src/lib/libtor-version-testing.a \
100 src/lib/libtor-intmath.a \
101 src/lib/libtor-ctime-testing.a
104 # Internal crypto libraries used in Tor
106 src/lib/libtor-tls.a \
107 src/lib/libtor-crypt-ops.a \
111 # Variants of the above for linking the testing variant of tor (for coverage
114 TOR_CRYPTO_TESTING_LIBS = \
115 src/lib/libtor-tls-testing.a \
116 src/lib/libtor-crypt-ops-testing.a \
121 # All static libraries used to link tor.
122 TOR_INTERNAL_LIBS = \
123 src/core/libtor-app.a \
124 src/lib/libtor-compress.a \
125 src/lib/libtor-evloop.a \
128 src/trunnel/libor-trunnel.a \
129 src/lib/libtor-trace.a
131 # Variants of the above for linking the testing variant of tor (for coverage
134 TOR_INTERNAL_TESTING_LIBS = \
135 src/core/libtor-app-testing.a \
136 src/lib/libtor-compress-testing.a \
137 src/lib/libtor-evloop-testing.a \
138 $(TOR_CRYPTO_TESTING_LIBS) \
139 $(TOR_UTIL_TESTING_LIBS) \
140 src/trunnel/libor-trunnel-testing.a \
141 src/lib/libtor-trace.a
144 TOR_LDFLAGS_CRYPTLIB=@TOR_LDFLAGS_openssl@
145 TOR_LIBS_CRYPTLIB=@TOR_OPENSSL_LIBS@
148 TOR_CFLAGS_CRYPTLIB+=@NSS_CFLAGS@
149 TOR_LIBS_CRYPTLIB+=@NSS_LIBS@
152 # All libraries used to link tor-cov
154 include src/include.am
155 include doc/include.am
156 include contrib/include.am
167 scripts/maint/checkIncludes.py \
168 scripts/maint/checkSpace.pl \
169 scripts/maint/practracker
172 ## This tells etags how to find mockable function definitions.
173 AM_ETAGSFLAGS=--regex='{c}/MOCK_IMPL([^,]+,\W*\([a-zA-Z0-9_]+\)\W*,/\1/s'
176 TEST_CFLAGS=-fno-inline -fprofile-arcs -ftest-coverage
177 if DISABLE_ASSERTS_IN_UNIT_TESTS
178 TEST_CPPFLAGS=-DTOR_UNIT_TESTS -DTOR_COVERAGE -DDISABLE_ASSERTS_IN_UNIT_TESTS @TOR_MODULES_ALL_ENABLED@
180 TEST_CPPFLAGS=-DTOR_UNIT_TESTS -DTOR_COVERAGE @TOR_MODULES_ALL_ENABLED@
182 TEST_NETWORK_FLAGS=--coverage --hs-multi-client 1
185 TEST_CPPFLAGS=-DTOR_UNIT_TESTS @TOR_MODULES_ALL_ENABLED@
186 TEST_NETWORK_FLAGS=--hs-multi-client 1
188 TEST_NETWORK_WARNING_FLAGS=--quiet --only-warnings
191 TEST_CFLAGS += -fsanitize-coverage=trace-pc-guard,trace-cmp,trace-div
195 TEST_NETWORK_ALL_LOG_DIR=$(top_builddir)/test_network_log
196 TEST_NETWORK_ALL_DRIVER_FLAGS=--color-tests yes
199 # $(INSTALL) -m 755 -d $(LOCALSTATEDIR)/lib/tor
201 # Allows to override rpmbuild with rpmbuild-md5 from fedora-packager so that
202 # building for EL5 won't fail on https://bugzilla.redhat.com/show_bug.cgi?id=490613
205 # Use automake's dist-gzip target to build the tarball
207 TIMESTAMP=$$(date +"%Y-%m-%d_%H.%M.%S"); \
208 RPM_BUILD_DIR=$$(mktemp -d "/tmp/tor-rpm-build-$$TIMESTAMP-XXXX"); \
209 mkdir -p "$$RPM_BUILD_DIR"/{BUILD,RPMS,SOURCES/"tor-$(VERSION)",SPECS,SRPMS}; \
210 cp -fa "$(distdir).tar.gz" "$$RPM_BUILD_DIR"/SOURCES/; \
211 LIBS=-lrt $(RPMBUILD) -ba --define "_topdir $$RPM_BUILD_DIR" tor.spec; \
212 cp -fa "$$RPM_BUILD_DIR"/SRPMS/* .; \
213 cp -fa "$$RPM_BUILD_DIR"/RPMS/* .; \
214 rm -rf "$$RPM_BUILD_DIR"; \
215 echo "RPM build finished"; \
219 doxygen && cd doc/doxygen/latex && make
222 $(top_builddir)/src/test/test
225 # Only use shellcheck if it is present
226 if command -v shellcheck; then \
227 find $(top_srcdir)/scripts/ -name "*.sh" -exec shellcheck {} +; \
228 if [ -d "$(top_srcdir)/scripts/test" ]; then \
229 shellcheck $(top_srcdir)/scripts/test/cov-diff $(top_srcdir)/scripts/test/coverage; \
233 check-local: check-spaces check-changes check-includes shellcheck
236 @if test ! -d "$$CHUTNEY_PATH"; then \
237 echo '$$CHUTNEY_PATH was not set.'; \
238 if test -d $(top_srcdir)/../chutney -a -x $(top_srcdir)/../chutney/chutney; then \
239 echo "Assuming test-network.sh will find" $(top_srcdir)/../chutney; \
242 echo "To run these tests, git clone https://git.torproject.org/chutney.git ; export CHUTNEY_PATH=\`pwd\`/chutney"; \
247 # Note that test-network requires a copy of Chutney in $CHUTNEY_PATH.
248 # Chutney can be cloned from https://git.torproject.org/chutney.git .
249 test-network: need-chutney-path $(TESTING_TOR_BINARY) src/tools/tor-gencert
250 $(top_srcdir)/src/test/test-network.sh $(TEST_NETWORK_FLAGS)
252 # Run all available tests using automake's test-driver
253 # only run IPv6 tests if we can ping6 ::1 (localhost)
254 # only run IPv6 tests if we can ping ::1 (localhost)
255 # some IPv6 tests will fail without an IPv6 DNS server (see #16971 and #17011)
256 # only run mixed tests if we have a tor-stable binary
257 # Try the syntax for BSD ping6, Linux ping6, and Linux ping -6,
258 # because they're incompatible
259 test-network-all: need-chutney-path test-driver $(TESTING_TOR_BINARY) src/tools/tor-gencert
260 mkdir -p $(TEST_NETWORK_ALL_LOG_DIR)
261 rm -f $(TEST_NETWORK_ALL_LOG_DIR)/*.log $(TEST_NETWORK_ALL_LOG_DIR)/*.trs
262 @flavors="$(TEST_CHUTNEY_FLAVORS)"; \
263 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 \
264 echo "ping6 ::1 or ping ::1 succeeded, running IPv6 flavors: $(TEST_CHUTNEY_FLAVORS_IPV6)."; \
265 flavors="$$flavors $(TEST_CHUTNEY_FLAVORS_IPV6)"; \
267 echo "ping6 ::1 and ping ::1 failed, skipping IPv6 flavors: $(TEST_CHUTNEY_FLAVORS_IPV6)."; \
268 skip_flavors="$$skip_flavors $(TEST_CHUTNEY_FLAVORS_IPV6)"; \
270 if command -v tor-stable >/dev/null 2>&1; then \
271 echo "tor-stable found, running mixed flavors: $(TEST_CHUTNEY_FLAVORS_MIXED)."; \
272 flavors="$$flavors $(TEST_CHUTNEY_FLAVORS_MIXED)"; \
274 echo "tor-stable not found, skipping mixed flavors: $(TEST_CHUTNEY_FLAVORS_MIXED)."; \
275 skip_flavors="$$skip_flavors $(TEST_CHUTNEY_FLAVORS_MIXED)"; \
277 for f in $$skip_flavors; do \
280 for f in $$flavors; do \
281 $(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); \
282 $(top_srcdir)/src/test/test-network.sh $(TEST_NETWORK_WARNING_FLAGS); \
284 echo "Log and result files are available in $(TEST_NETWORK_ALL_LOG_DIR)."; \
285 ! grep -q FAIL $(TEST_NETWORK_ALL_LOG_DIR)/*.trs
288 @if test ! -d "$$STEM_SOURCE_DIR"; then \
289 echo '$$STEM_SOURCE_DIR was not set.'; echo; \
290 echo "To run these tests, git clone https://git.torproject.org/stem.git/ ; export STEM_SOURCE_DIR=\`pwd\`/stem"; \
294 test-stem: need-stem-path $(TESTING_TOR_BINARY)
295 @$(PYTHON) "$$STEM_SOURCE_DIR"/run_tests.py --tor "$(TESTING_TOR_BINARY)" --integ --log notice --target RUN_ALL;
297 test-stem-full: need-stem-path $(TESTING_TOR_BINARY)
298 @$(PYTHON) "$$STEM_SOURCE_DIR"/run_tests.py --tor "$(TESTING_TOR_BINARY)" --all --log notice --target RUN_ALL,ONLINE -v;
300 test-full: need-stem-path need-chutney-path check test-network test-stem
302 test-full-online: need-stem-path need-chutney-path check test-network test-stem-full
304 # We can't delete the gcno files, because they are created when tor is compiled
306 rm -f $(top_builddir)/src/*/*.gcda $(top_builddir)/src/*/*/*.gcda \
307 $(top_builddir)/src/*/*.gcov $(top_builddir)/src/*/*/*.gcov
309 HTML_COVER_DIR=$(top_builddir)/coverage_html
312 test -e "`which lcov`" || (echo "lcov must be installed. See <http://ltp.sourceforge.net/coverage/lcov.php>." && false)
313 test -d "$(HTML_COVER_DIR)" || $(MKDIR_P) "$(HTML_COVER_DIR)"
314 lcov --rc lcov_branch_coverage=1 --directory $(top_builddir)/src --zerocounters
317 lcov --capture --rc lcov_branch_coverage=1 --no-external --directory $(top_builddir) --base-directory $(top_srcdir) --output-file "$(HTML_COVER_DIR)/lcov.tmp"
318 lcov --remove "$(HTML_COVER_DIR)/lcov.tmp" --rc lcov_branch_coverage=1 'test/*' 'ext/tinytest*' '/usr/*' --output-file "$(HTML_COVER_DIR)/lcov.info"
319 genhtml --branch-coverage -o "$(HTML_COVER_DIR)" "$(HTML_COVER_DIR)/lcov.info"
321 @printf "Not configured with --enable-coverage, run ./configure --enable-coverage\n"
324 coverage-html-full: all
325 test -e "`which lcov`" || (echo "lcov must be installed. See <http://ltp.sourceforge.net/coverage/lcov.php>." && false)
326 test -d "$(HTML_COVER_DIR)" || mkdir -p "$(HTML_COVER_DIR)"
327 lcov --rc lcov_branch_coverage=1 --directory ./src --zerocounters
330 $(MAKE) test-stem-full
331 CHUTNEY_TOR=tor-cov CHUTNEY_TOR_GENCERT=tor-cov-gencert $(top_srcdir)/src/test/test-network.sh
332 CHUTNEY_TOR=tor-cov CHUTNEY_TOR_GENCERT=tor-cov-gencert $(top_srcdir)/src/test/test-network.sh --flavor hs
333 lcov --capture --rc lcov_branch_coverage=1 --no-external --directory . --output-file "$(HTML_COVER_DIR)/lcov.tmp"
334 lcov --remove "$(HTML_COVER_DIR)/lcov.tmp" --rc lcov_branch_coverage=1 'test/*' 'ext/tinytest*' '/usr/*' --output-file "$(HTML_COVER_DIR)/lcov.info"
335 genhtml --branch-coverage -o "$(HTML_COVER_DIR)" "$(HTML_COVER_DIR)/lcov.info"
337 # For scripts: avoid src/ext and src/trunnel.
339 $(top_srcdir)/src/lib/*/*.[ch] \
340 $(top_srcdir)/src/core/*/*.[ch] \
341 $(top_srcdir)/src/feature/*/*.[ch] \
342 $(top_srcdir)/src/app/*/*.[ch] \
343 $(top_srcdir)/src/test/*.[ch] \
344 $(top_srcdir)/src/test/*/*.[ch] \
345 $(top_srcdir)/src/tools/*.[ch]
349 $(PERL) $(top_srcdir)/scripts/maint/checkSpace.pl -C \
355 $(PYTHON) $(top_srcdir)/scripts/maint/checkIncludes.py
358 check-best-practices:
360 $(PYTHON) $(top_srcdir)/scripts/maint/practracker/practracker.py $(top_srcdir)
364 $(PYTHON) $(top_srcdir)/scripts/maint/practracker/practracker.py --regen $(top_srcdir)
367 $(PERL) $(top_builddir)/scripts/maint/checkOptionDocs.pl
370 $(top_srcdir)/scripts/maint/checkLogs.pl \
371 $(top_srcdir)/src/*/*.[ch] | sort -n
375 @if test -x "`which misspell 2>&1;true`"; then \
376 echo "Checking for Typos ..."; \
378 $(top_srcdir)/src/[^e]*/*.[ch] \
380 $(top_srcdir)/contrib \
381 $(top_srcdir)/scripts \
382 $(top_srcdir)/README \
383 $(top_srcdir)/ChangeLog \
384 $(top_srcdir)/INSTALL \
385 $(top_srcdir)/ReleaseNotes \
386 $(top_srcdir)/LICENSE); \
388 echo "Tor can use misspell to check for typos."; \
389 echo "It seems that you don't have misspell installed."; \
390 echo "You can install the latest version of misspell here: https://github.com/client9/misspell#install"; \
396 @if test -x "`which cargo-fmt 2>&1;true`"; then \
397 echo "Formatting Rust code ..."; \
398 (cd "$(top_srcdir)/src/rust" && cargo fmt --all --); \
400 echo "Tor uses rustfmt (via cargo-fmt) to format Rust code."; \
401 echo "However, it seems that you don't have rustfmt installed."; \
402 printf "You can install rustfmt by following the directions here:"; \
403 echo " https://github.com/rust-lang-nursery/rustfmt"; \
407 .PHONY: check-rustfmt
410 @if test -x "`which cargo-fmt 2>&1;true`"; then \
411 printf "Running rustfmt..."; \
412 (cd "$(top_srcdir)/src/rust" && cargo fmt --all -- --check && echo "done.") || \
413 (echo "**************** check-rustfmt failed. ****************"; \
414 echo " Run \`make rustfmt\` to apply the above changes."; \
417 echo "Tor uses rustfmt (via cargo-fmt) to format Rust code."; \
418 echo "However, it seems that you don't have rustfmt installed."; \
419 printf "You can install rustfmt by following the directions here:"; \
420 echo " https://github.com/rust-lang-nursery/rustfmt"; \
427 @if test -x "`which cargo-clippy 2>&1;true`"; then \
428 echo "Running cargo clippy ..."; \
429 echo "Prepare yourself for the onslaught of suggestions ..."; \
430 (cd "$(top_srcdir)/src/rust" && cargo clippy); \
432 echo "Tor can use clippy to lint Rust code."; \
433 echo "However, it seems that you don't have clippy installed."; \
434 echo "You can install the latest version of clippy by following the directions here: https://github.com/rust-lang-nursery/rust-clippy"; \
438 .PHONY: check-changes
441 @if test -d "$(top_srcdir)/changes"; then \
442 PACKAGE_VERSION=$(PACKAGE_VERSION) $(PYTHON) $(top_srcdir)/scripts/maint/lintChanges.py $(top_srcdir)/changes; \
446 .PHONY: update-versions
448 abs_top_srcdir="$(abs_top_srcdir)" $(PYTHON) $(top_srcdir)/scripts/maint/update_versions.py
452 $(top_builddir)/scripts/maint/run_calltool.sh
455 @echo "Tor @VERSION@"
456 @if test -d "$(top_srcdir)/.git" && test -x "`which git 2>&1;true`"; then \
458 (cd "$(top_srcdir)" && git rev-parse --short=16 HEAD); \
461 .PHONY: autostyle-ifdefs
463 $(PYTHON) scripts/maint/annotate_ifdef_directives $(OWNED_TOR_C_FILES)
465 .PHONY: autostyle-ifdefs
467 $(PERL) scripts/coccinelle/test-operator-cleanup $(OWNED_TOR_C_FILES)
469 .PHONY: rectify-includes
471 $(PYTHON) scripts/maint/rectify_include_paths.py
473 .PHONY: update-copyright
475 $(PERL) scripts/maint/updateCopyright.pl $(OWNED_TOR_C_FILES)
478 autostyle: update-versions rustfmt autostyle-ifdefs rectify-includes
481 rm -f $(top_builddir)/src/*/*.gc{da,no} $(top_builddir)/src/*/*/*.gc{da,no}
482 rm -rf $(HTML_COVER_DIR)
483 rm -rf $(top_builddir)/doc/doxygen
484 rm -rf $(TEST_NETWORK_ALL_LOG_DIR)
487 rm -rf $(top_builddir)/src/rust/target
488 rm -rf $(top_builddir)/src/rust/.cargo/registry
491 distclean-local: distclean-rust
494 # This relies on some internal details of how automake implements
495 # distcheck. We check two directories because automake-1.15 changed
496 # from $(distdir)/_build to $(distdir)/_build/sub.
497 show-distdir-testlog:
498 @if test -d "$(distdir)/_build/sub"; then \
499 cat $(distdir)/_build/sub/$(TEST_SUITE_LOG); \
501 cat $(distdir)/_build/$(TEST_SUITE_LOG); fi
503 # Similarly, this relies on automake internals to run file on an
504 # intermittent core file whose provenance is not known to us. See
507 @if test -d "$(distdir)/_build/sub"; then \
508 file $(distdir)/_build/sub/core ; \
510 file $(distdir)/_build/core; fi
513 @echo $(TOR_INTERNAL_LIBS)
516 @echo $(TOR_INTERNAL_TESTING_LIBS)