Split select_entry_guard_for_circuit()
[tor.git] / Makefile.am
blob202197f5f57670c2403a6f231ccf6339183e5870
1 # Copyright (c) 2001-2004, Roger Dingledine
2 # Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson
3 # Copyright (c) 2007-2018, The Tor Project, Inc.
4 # See LICENSE for licensing information
6 ACLOCAL_AMFLAGS = -I m4
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
24 AM_CFLAGS=@TOR_SYSTEMD_CFLAGS@ @CFLAGS_BUGTRAP@ @TOR_LZMA_CFLAGS@ @TOR_ZSTD_CFLAGS@
25 SHELL=@SHELL@
27 if COVERAGE_ENABLED
28 TESTING_TOR_BINARY=$(top_builddir)/src/app/tor-cov$(EXEEXT)
29 else
30 TESTING_TOR_BINARY=$(top_builddir)/src/app/tor$(EXEEXT)
31 endif
33 if USE_RUST
34 ## this MUST be $(), otherwise am__DEPENDENCIES will not track it
35 rust_ldadd=$(top_builddir)/$(TOR_RUST_LIB_PATH) \
36         $(TOR_RUST_EXTRA_LIBS)
37 else
38 rust_ldadd=
39 endif
41 # "Common" libraries used to link tor's utility code.
42 TOR_UTIL_LIBS = \
43         src/lib/libtor-process.a \
44         src/lib/libtor-time.a \
45         src/lib/libtor-fs.a \
46         src/lib/libtor-encoding.a \
47         src/lib/libtor-sandbox.a \
48         src/lib/libtor-container.a \
49         src/lib/libtor-net.a \
50         src/lib/libtor-thread.a \
51         src/lib/libtor-memarea.a \
52         src/lib/libtor-math.a \
53         src/lib/libtor-meminfo.a \
54         src/lib/libtor-osinfo.a \
55         src/lib/libtor-log.a \
56         src/lib/libtor-lock.a \
57         src/lib/libtor-fdio.a \
58         src/lib/libtor-string.a \
59         src/lib/libtor-term.a \
60         src/lib/libtor-smartlist-core.a \
61         src/lib/libtor-malloc.a \
62         src/lib/libtor-wallclock.a \
63         src/lib/libtor-err.a \
64         src/lib/libtor-intmath.a \
65         src/lib/libtor-ctime.a
67 # Variants of the above for linking the testing variant of tor (for coverage
68 # and tests)
69 if UNITTESTS_ENABLED
70 TOR_UTIL_TESTING_LIBS = \
71         src/lib/libtor-process-testing.a \
72         src/lib/libtor-time-testing.a \
73         src/lib/libtor-fs-testing.a \
74         src/lib/libtor-encoding-testing.a \
75         src/lib/libtor-sandbox-testing.a \
76         src/lib/libtor-container-testing.a \
77         src/lib/libtor-net-testing.a \
78         src/lib/libtor-thread-testing.a \
79         src/lib/libtor-memarea-testing.a \
80         src/lib/libtor-math-testing.a \
81         src/lib/libtor-meminfo-testing.a \
82         src/lib/libtor-osinfo-testing.a \
83         src/lib/libtor-term-testing.a \
84         src/lib/libtor-log-testing.a \
85         src/lib/libtor-lock-testing.a \
86         src/lib/libtor-fdio-testing.a \
87         src/lib/libtor-string-testing.a \
88         src/lib/libtor-smartlist-core-testing.a \
89         src/lib/libtor-malloc-testing.a \
90         src/lib/libtor-wallclock-testing.a \
91         src/lib/libtor-err-testing.a \
92         src/lib/libtor-intmath.a \
93         src/lib/libtor-ctime-testing.a
94 endif
96 # Internal crypto libraries used in Tor
97 TOR_CRYPTO_LIBS = \
98         src/lib/libtor-tls.a \
99         src/lib/libtor-crypt-ops.a \
100         $(LIBKECCAK_TINY) \
101         $(LIBDONNA)
103 # Variants of the above for linking the testing variant of tor (for coverage
104 # and tests)
105 if UNITTESTS_ENABLED
106 TOR_CRYPTO_TESTING_LIBS = \
107         src/lib/libtor-tls-testing.a \
108         src/lib/libtor-crypt-ops-testing.a \
109         $(LIBKECCAK_TINY) \
110         $(LIBDONNA)
111 endif
113 # All static libraries used to link tor.
114 TOR_INTERNAL_LIBS = \
115         src/core/libtor-app.a \
116         src/lib/libtor-compress.a \
117         src/lib/libtor-evloop.a \
118         $(TOR_CRYPTO_LIBS) \
119         $(TOR_UTIL_LIBS) \
120         src/trunnel/libor-trunnel.a \
121         src/lib/libtor-trace.a
123 # Variants of the above for linking the testing variant of tor (for coverage
124 # and tests)
125 if UNITTESTS_ENABLED
126 TOR_INTERNAL_TESTING_LIBS = \
127         src/core/libtor-app-testing.a \
128         src/lib/libtor-compress-testing.a \
129         src/lib/libtor-evloop-testing.a \
130         $(TOR_CRYPTO_TESTING_LIBS) \
131         $(TOR_UTIL_TESTING_LIBS) \
132         src/trunnel/libor-trunnel-testing.a \
133         src/lib/libtor-trace.a
134 endif
136 # All libraries used to link tor-cov
138 include src/include.am
139 include doc/include.am
140 include contrib/include.am
142 EXTRA_DIST+= \
143         ChangeLog                                       \
144         CONTRIBUTING                                    \
145         CODE_OF_CONDUCT                                 \
146         INSTALL                                         \
147         LICENSE                                         \
148         Makefile.nmake                                  \
149         README                                          \
150         ReleaseNotes                                    \
151         scripts/maint/checkIncludes.py                  \
152         scripts/maint/checkSpace.pl
154 ## This tells etags how to find mockable function definitions.
155 AM_ETAGSFLAGS=--regex='{c}/MOCK_IMPL([^,]+,\W*\([a-zA-Z0-9_]+\)\W*,/\1/s'
157 if COVERAGE_ENABLED
158 TEST_CFLAGS=-fno-inline -fprofile-arcs -ftest-coverage
159 if DISABLE_ASSERTS_IN_UNIT_TESTS
160 TEST_CPPFLAGS=-DTOR_UNIT_TESTS -DTOR_COVERAGE -DDISABLE_ASSERTS_IN_UNIT_TESTS @TOR_MODULES_ALL_ENABLED@
161 else
162 TEST_CPPFLAGS=-DTOR_UNIT_TESTS -DTOR_COVERAGE @TOR_MODULES_ALL_ENABLED@
163 endif
164 TEST_NETWORK_FLAGS=--coverage --hs-multi-client 1
165 else
166 TEST_CFLAGS=
167 TEST_CPPFLAGS=-DTOR_UNIT_TESTS @TOR_MODULES_ALL_ENABLED@
168 TEST_NETWORK_FLAGS=--hs-multi-client 1
169 endif
170 TEST_NETWORK_WARNING_FLAGS=--quiet --only-warnings
172 if LIBFUZZER_ENABLED
173 TEST_CFLAGS += -fsanitize-coverage=trace-pc-guard,trace-cmp,trace-div
174 # not "edge"
175 endif
177 TEST_NETWORK_ALL_LOG_DIR=$(top_builddir)/test_network_log
178 TEST_NETWORK_ALL_DRIVER_FLAGS=--color-tests yes
180 #install-data-local:
181 #       $(INSTALL) -m 755 -d $(LOCALSTATEDIR)/lib/tor
183 # Allows to override rpmbuild with rpmbuild-md5 from fedora-packager so that
184 # building for EL5 won't fail on https://bugzilla.redhat.com/show_bug.cgi?id=490613
185 RPMBUILD ?= rpmbuild
187 # Use automake's dist-gzip target to build the tarball
188 dist-rpm: dist-gzip
189         TIMESTAMP=$$(date +"%Y-%m-%d_%H.%M.%S");                                \
190         RPM_BUILD_DIR=$$(mktemp -d "/tmp/tor-rpm-build-$$TIMESTAMP-XXXX");      \
191         mkdir -p "$$RPM_BUILD_DIR"/{BUILD,RPMS,SOURCES/"tor-$(VERSION)",SPECS,SRPMS}; \
192         cp -fa "$(distdir).tar.gz" "$$RPM_BUILD_DIR"/SOURCES/;                  \
193         LIBS=-lrt $(RPMBUILD) -ba --define "_topdir $$RPM_BUILD_DIR" tor.spec;  \
194         cp -fa "$$RPM_BUILD_DIR"/SRPMS/* .;                                     \
195         cp -fa "$$RPM_BUILD_DIR"/RPMS/* .;                                      \
196         rm -rf "$$RPM_BUILD_DIR";                                               \
197         echo "RPM build finished";                                              \
198         #end of dist-rpm
200 doxygen:
201         doxygen && cd doc/doxygen/latex && make
203 test: all
204         $(top_builddir)/src/test/test
206 check-local: check-spaces check-changes
208 need-chutney-path:
209         @if test ! -d "$$CHUTNEY_PATH"; then \
210                 echo '$$CHUTNEY_PATH was not set.'; \
211                 if test -d $(top_srcdir)/../chutney -a -x $(top_srcdir)/../chutney/chutney; then \
212                         echo "Assuming test-network.sh will find" $(top_srcdir)/../chutney; \
213                 else \
214                         echo; \
215                         echo "To run these tests, git clone https://git.torproject.org/chutney.git ; export CHUTNEY_PATH=\`pwd\`/chutney"; \
216                         exit 1; \
217                 fi \
218         fi
220 # Note that test-network requires a copy of Chutney in $CHUTNEY_PATH.
221 # Chutney can be cloned from https://git.torproject.org/chutney.git .
222 test-network: need-chutney-path $(TESTING_TOR_BINARY) src/tools/tor-gencert
223         $(top_srcdir)/src/test/test-network.sh $(TEST_NETWORK_FLAGS)
225 # Run all available tests using automake's test-driver
226 # only run IPv6 tests if we can ping6 ::1 (localhost)
227 # only run IPv6 tests if we can ping ::1 (localhost)
228 # some IPv6 tests will fail without an IPv6 DNS server (see #16971 and #17011)
229 # only run mixed tests if we have a tor-stable binary
230 # Try the syntax for BSD ping6, Linux ping6, and Linux ping -6,
231 # because they're incompatible
232 test-network-all: need-chutney-path test-driver $(TESTING_TOR_BINARY) src/tools/tor-gencert
233         mkdir -p $(TEST_NETWORK_ALL_LOG_DIR)
234         @flavors="$(TEST_CHUTNEY_FLAVORS)"; \
235         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 \
236                 echo "ping6 ::1 or ping ::1 succeeded, running IPv6 flavors: $(TEST_CHUTNEY_FLAVORS_IPV6)."; \
237                 flavors="$$flavors $(TEST_CHUTNEY_FLAVORS_IPV6)"; \
238         else \
239                 echo "ping6 ::1 and ping ::1 failed, skipping IPv6 flavors: $(TEST_CHUTNEY_FLAVORS_IPV6)."; \
240                 skip_flavors="$$skip_flavors $(TEST_CHUTNEY_FLAVORS_IPV6)"; \
241         fi; \
242         if command -v tor-stable >/dev/null 2>&1; then \
243                 echo "tor-stable found, running mixed flavors: $(TEST_CHUTNEY_FLAVORS_MIXED)."; \
244                 flavors="$$flavors $(TEST_CHUTNEY_FLAVORS_MIXED)"; \
245         else \
246                 echo "tor-stable not found, skipping mixed flavors: $(TEST_CHUTNEY_FLAVORS_MIXED)."; \
247                 skip_flavors="$$skip_flavors $(TEST_CHUTNEY_FLAVORS_MIXED)"; \
248         fi; \
249         for f in $$skip_flavors; do \
250                 echo "SKIP: $$f"; \
251         done; \
252         for f in $$flavors; do \
253                 $(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); \
254                 $(top_srcdir)/src/test/test-network.sh $(TEST_NETWORK_WARNING_FLAGS); \
255         done; \
256         echo "Log and result files are available in $(TEST_NETWORK_ALL_LOG_DIR)."; \
257         ! grep -q FAIL test_network_log/*.trs
259 need-stem-path:
260         @if test ! -d "$$STEM_SOURCE_DIR"; then \
261                 echo '$$STEM_SOURCE_DIR was not set.'; echo; \
262                 echo "To run these tests, git clone https://git.torproject.org/stem.git/ ; export STEM_SOURCE_DIR=\`pwd\`/stem"; \
263                 exit 1; \
264         fi
266 test-stem: need-stem-path $(TESTING_TOR_BINARY)
267         @$(PYTHON) "$$STEM_SOURCE_DIR"/run_tests.py --tor "$(TESTING_TOR_BINARY)" --all --log notice --target RUN_ALL;
269 test-stem-full: need-stem-path $(TESTING_TOR_BINARY)
270         @$(PYTHON) "$$STEM_SOURCE_DIR"/run_tests.py --tor "$(TESTING_TOR_BINARY)" --all --log notice --target RUN_ALL,ONLINE -v;
272 test-full: need-stem-path need-chutney-path check test-network test-stem
274 test-full-online: need-stem-path need-chutney-path check test-network test-stem-full
276 reset-gcov:
277         rm -f $(top_builddir)/src/*/*.gcda $(top_builddir)/src/*/*/*.gcda
279 HTML_COVER_DIR=$(top_builddir)/coverage_html
280 coverage-html: all
281 if COVERAGE_ENABLED
282         test -e "`which lcov`" || (echo "lcov must be installed. See <http://ltp.sourceforge.net/coverage/lcov.php>." && false)
283         test -d "$(HTML_COVER_DIR)" || $(MKDIR_P) "$(HTML_COVER_DIR)"
284         lcov --rc lcov_branch_coverage=1 --directory $(top_builddir)/src --zerocounters
285         $(MAKE) reset-gcov
286         $(MAKE) check
287         lcov --capture --rc lcov_branch_coverage=1 --no-external --directory $(top_builddir) --base-directory $(top_srcdir) --output-file "$(HTML_COVER_DIR)/lcov.tmp"
288         lcov --remove "$(HTML_COVER_DIR)/lcov.tmp" --rc lcov_branch_coverage=1 'test/*' 'ext/tinytest*' '/usr/*' --output-file "$(HTML_COVER_DIR)/lcov.info"
289         genhtml --branch-coverage -o "$(HTML_COVER_DIR)" "$(HTML_COVER_DIR)/lcov.info"
290 else
291         @printf "Not configured with --enable-coverage, run ./configure --enable-coverage\n"
292 endif
294 coverage-html-full: all
295         test -e "`which lcov`" || (echo "lcov must be installed. See <http://ltp.sourceforge.net/coverage/lcov.php>." && false)
296         test -d "$(HTML_COVER_DIR)" || mkdir -p "$(HTML_COVER_DIR)"
297         lcov --rc lcov_branch_coverage=1 --directory ./src --zerocounters
298         $(MAKE) reset-gcov
299         $(MAKE) check
300         $(MAKE) test-stem-full
301         CHUTNEY_TOR=tor-cov CHUTNEY_TOR_GENCERT=tor-cov-gencert $(top_srcdir)/src/test/test-network.sh
302         CHUTNEY_TOR=tor-cov CHUTNEY_TOR_GENCERT=tor-cov-gencert $(top_srcdir)/src/test/test-network.sh --flavor hs
303         lcov --capture --rc lcov_branch_coverage=1 --no-external --directory . --output-file "$(HTML_COVER_DIR)/lcov.tmp"
304         lcov --remove "$(HTML_COVER_DIR)/lcov.tmp" --rc lcov_branch_coverage=1 'test/*' 'ext/tinytest*' '/usr/*' --output-file "$(HTML_COVER_DIR)/lcov.info"
305         genhtml --branch-coverage -o "$(HTML_COVER_DIR)" "$(HTML_COVER_DIR)/lcov.info"
307 # Avoid strlcpy.c, strlcat.c, aes.c, OpenBSD_malloc_Linux.c, sha256.c,
308 # tinytest*.[ch]
309 check-spaces:
310 if USE_PERL
311         $(PERL) $(top_srcdir)/scripts/maint/checkSpace.pl -C \
312                 $(top_srcdir)/src/lib/*/*.[ch] \
313                 $(top_srcdir)/src/core/*/*.[ch] \
314                 $(top_srcdir)/src/feature/*/*.[ch] \
315                 $(top_srcdir)/src/app/*/*.[ch] \
316                 $(top_srcdir)/src/test/*.[ch] \
317                 $(top_srcdir)/src/test/*/*.[ch] \
318                 $(top_srcdir)/src/tools/*.[ch]
319 endif
321 check-includes:
322 if USEPYTHON
323         $(top_srcdir)/scripts/maint/checkIncludes.py
324 endif
326 check-docs: all
327         $(PERL) $(top_builddir)/scripts/maint/checkOptionDocs.pl
329 check-logs:
330         $(top_srcdir)/scripts/maint/checkLogs.pl \
331                 $(top_srcdir)/src/*/*.[ch] | sort -n
333 .PHONY: check-typos
334 check-typos:
335         @if test -x "`which misspell 2>&1;true`"; then \
336                 echo "Checking for Typos ..."; \
337                 (misspell \
338                         $(top_srcdir)/src/[^e]*/*.[ch] \
339                         $(top_srcdir)/doc \
340                         $(top_srcdir)/contrib \
341                         $(top_srcdir)/scripts \
342                         $(top_srcdir)/README \
343                         $(top_srcdir)/ChangeLog \
344                         $(top_srcdir)/INSTALL \
345                         $(top_srcdir)/ReleaseNotes \
346                         $(top_srcdir)/LICENSE); \
347         else \
348                 echo "Tor can use misspell to check for typos."; \
349                 echo "It seems that you don't have misspell installed."; \
350                 echo "You can install the latest version of misspell here: https://github.com/client9/misspell#install"; \
351         fi
353 .PHONY: clippy
354 clippy:
355 if USE_RUST
356         @if test -x "`which cargo-clippy 2>&1;true`"; then \
357                 echo "Running cargo clippy ..."; \
358                 echo "Prepare yourself for the onslaught of suggestions ..."; \
359                 (cd "$(top_srcdir)/src/rust" && cargo clippy); \
360         else \
361                 echo "Tor can use clippy to lint Rust code."; \
362                 echo "However, it seems that you don't have clippy installed."; \
363                 echo "You can install the latest version of clippy by following the directions here: https://github.com/rust-lang-nursery/rust-clippy"; \
364         fi
365 endif
367 .PHONY: check-changes
368 check-changes:
369 if USEPYTHON
370         @if test -d "$(top_srcdir)/changes"; then \
371                 $(PYTHON) $(top_srcdir)/scripts/maint/lintChanges.py $(top_srcdir)/changes; \
372                 fi
373 endif
375 .PHONY: update-versions
376 update-versions:
377         $(PERL) $(top_builddir)/scripts/maint/updateVersions.pl
379 .PHONY: callgraph
380 callgraph:
381         $(top_builddir)/scripts/maint/run_calltool.sh
383 version:
384         @echo "Tor @VERSION@"
385         @if test -d "$(top_srcdir)/.git" && test -x "`which git 2>&1;true`"; then \
386            echo -n "git: " ;\
387            (cd "$(top_srcdir)" && git rev-parse --short=16 HEAD); \
388         fi
390 mostlyclean-local:
391         rm -f $(top_builddir)/src/*/*.gc{da,no} $(top_builddir)/src/*/*/*.gc{da,no}
392         rm -rf $(HTML_COVER_DIR)
393         rm -rf $(top_builddir)/doc/doxygen
394         rm -rf $(TEST_NETWORK_ALL_LOG_DIR)
396 clean-local:
397         rm -rf $(top_builddir)/src/rust/target
398         rm -rf $(top_builddir)/src/rust/.cargo/registry
400 if USE_RUST
401 distclean-local: distclean-rust
402 endif
404 # This relies on some internal details of how automake implements
405 # distcheck.  We check two directories because automake-1.15 changed
406 # from $(distdir)/_build to $(distdir)/_build/sub.
407 show-distdir-testlog:
408         @if test -d "$(distdir)/_build/sub"; then \
409           cat $(distdir)/_build/sub/$(TEST_SUITE_LOG); \
410         else \
411           cat $(distdir)/_build/$(TEST_SUITE_LOG); fi
413 show-libs:
414         @echo $(TOR_INTERNAL_LIBS)
416 show-testing-libs:
417         @echo $(TOR_INTERNAL_TESTING_LIBS)