Makefile.am 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353
  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
  5. ACLOCAL_AMFLAGS = -I m4
  6. noinst_LIBRARIES=
  7. EXTRA_DIST=
  8. noinst_HEADERS=
  9. bin_PROGRAMS=
  10. EXTRA_PROGRAMS=
  11. CLEANFILES=
  12. TESTS=
  13. noinst_PROGRAMS=
  14. DISTCLEANFILES=
  15. bin_SCRIPTS=
  16. AM_CPPFLAGS=\
  17. -I$(top_srcdir)/src \
  18. -I$(top_srcdir)/src/ext \
  19. -I$(top_srcdir)/src/ext/trunnel \
  20. -I$(top_srcdir)/src/trunnel
  21. AM_CFLAGS=@TOR_SYSTEMD_CFLAGS@ @CFLAGS_BUGTRAP@ @TOR_LZMA_CFLAGS@ @TOR_ZSTD_CFLAGS@
  22. SHELL=@SHELL@
  23. if COVERAGE_ENABLED
  24. TESTING_TOR_BINARY=$(top_builddir)/src/or/tor-cov$(EXEEXT)
  25. else
  26. TESTING_TOR_BINARY=$(top_builddir)/src/or/tor$(EXEEXT)
  27. endif
  28. if USE_RUST
  29. rust_ldadd=$(top_builddir)/src/rust/target/release/@TOR_RUST_STATIC_NAME@ \
  30. @TOR_RUST_EXTRA_LIBS@
  31. else
  32. rust_ldadd=
  33. endif
  34. # "Common" libraries used to link tor's utility code.
  35. TOR_UTIL_LIBS = \
  36. src/common/libor.a \
  37. src/lib/libtor-err.a \
  38. src/lib/libtor-ctime.a
  39. # Variants of the above for linking the testing variant of tor (for coverage
  40. # and tests)
  41. TOR_UTIL_TESTING_LIBS = \
  42. src/common/libor-testing.a \
  43. src/lib/libtor-err-testing.a \
  44. src/lib/libtor-ctime-testing.a
  45. # Internal crypto libraries used in Tor
  46. TOR_CRYPTO_LIBS = \
  47. src/common/libor-crypto.a \
  48. $(LIBKECCAK_TINY) \
  49. $(LIBDONNA)
  50. # Variants of the above for linking the testing variant of tor (for coverage
  51. # and tests)
  52. TOR_CRYPTO_TESTING_LIBS = \
  53. src/common/libor-crypto-testing.a \
  54. $(LIBKECCAK_TINY) \
  55. $(LIBDONNA)
  56. # All static libraries used to link tor.
  57. TOR_INTERNAL_LIBS = \
  58. src/or/libtor-app.a \
  59. src/lib/libtor-compress.a \
  60. $(TOR_CRYPTO_LIBS) \
  61. $(TOR_UTIL_LIBS) \
  62. src/common/libor-event.a \
  63. src/trunnel/libor-trunnel.a \
  64. src/lib/libtor-trace.a
  65. # Variants of the above for linking the testing variant of tor (for coverage
  66. # and tests)
  67. TOR_INTERNAL_TESTING_LIBS = \
  68. src/or/libtor-app-testing.a \
  69. src/lib/libtor-compress-testing.a \
  70. $(TOR_CRYPTO_TESTING_LIBS) \
  71. $(TOR_UTIL_TESTING_LIBS) \
  72. src/common/libor-event-testing.a \
  73. src/trunnel/libor-trunnel-testing.a \
  74. src/lib/libtor-trace.a
  75. # All libraries used to link tor-cov
  76. include src/include.am
  77. include doc/include.am
  78. include contrib/include.am
  79. EXTRA_DIST+= \
  80. ChangeLog \
  81. CONTRIBUTING \
  82. INSTALL \
  83. LICENSE \
  84. Makefile.nmake \
  85. README \
  86. ReleaseNotes \
  87. scripts/maint/checkSpace.pl
  88. ## This tells etags how to find mockable function definitions.
  89. AM_ETAGSFLAGS=--regex='{c}/MOCK_IMPL([^,]+,\W*\([a-zA-Z0-9_]+\)\W*,/\1/s'
  90. if COVERAGE_ENABLED
  91. TEST_CFLAGS=-fno-inline -fprofile-arcs -ftest-coverage
  92. if DISABLE_ASSERTS_IN_UNIT_TESTS
  93. TEST_CPPFLAGS=-DTOR_UNIT_TESTS -DTOR_COVERAGE -DDISABLE_ASSERTS_IN_UNIT_TESTS @TOR_MODULES_ALL_ENABLED@
  94. else
  95. TEST_CPPFLAGS=-DTOR_UNIT_TESTS -DTOR_COVERAGE @TOR_MODULES_ALL_ENABLED@
  96. endif
  97. TEST_NETWORK_FLAGS=--coverage --hs-multi-client 1
  98. else
  99. TEST_CFLAGS=
  100. TEST_CPPFLAGS=-DTOR_UNIT_TESTS @TOR_MODULES_ALL_ENABLED@
  101. TEST_NETWORK_FLAGS=--hs-multi-client 1
  102. endif
  103. TEST_NETWORK_WARNING_FLAGS=--quiet --only-warnings
  104. if LIBFUZZER_ENABLED
  105. TEST_CFLAGS += -fsanitize-coverage=trace-pc-guard,trace-cmp,trace-div
  106. # not "edge"
  107. endif
  108. TEST_NETWORK_ALL_LOG_DIR=$(top_builddir)/test_network_log
  109. TEST_NETWORK_ALL_DRIVER_FLAGS=--color-tests yes
  110. #install-data-local:
  111. # $(INSTALL) -m 755 -d $(LOCALSTATEDIR)/lib/tor
  112. # Allows to override rpmbuild with rpmbuild-md5 from fedora-packager so that
  113. # building for EL5 won't fail on https://bugzilla.redhat.com/show_bug.cgi?id=490613
  114. RPMBUILD ?= rpmbuild
  115. # Use automake's dist-gzip target to build the tarball
  116. dist-rpm: dist-gzip
  117. TIMESTAMP=$$(date +"%Y-%m-%d_%H.%M.%S"); \
  118. RPM_BUILD_DIR=$$(mktemp -d "/tmp/tor-rpm-build-$$TIMESTAMP-XXXX"); \
  119. mkdir -p "$$RPM_BUILD_DIR"/{BUILD,RPMS,SOURCES/"tor-$(VERSION)",SPECS,SRPMS}; \
  120. cp -fa "$(distdir).tar.gz" "$$RPM_BUILD_DIR"/SOURCES/; \
  121. LIBS=-lrt $(RPMBUILD) -ba --define "_topdir $$RPM_BUILD_DIR" tor.spec; \
  122. cp -fa "$$RPM_BUILD_DIR"/SRPMS/* .; \
  123. cp -fa "$$RPM_BUILD_DIR"/RPMS/* .; \
  124. rm -rf "$$RPM_BUILD_DIR"; \
  125. echo "RPM build finished"; \
  126. #end of dist-rpm
  127. doxygen:
  128. doxygen && cd doc/doxygen/latex && make
  129. test: all
  130. $(top_builddir)/src/test/test
  131. check-local: check-spaces check-changes
  132. need-chutney-path:
  133. @if test ! -d "$$CHUTNEY_PATH"; then \
  134. echo '$$CHUTNEY_PATH was not set.'; \
  135. if test -d $(top_srcdir)/../chutney -a -x $(top_srcdir)/../chutney/chutney; then \
  136. echo "Assuming test-network.sh will find" $(top_srcdir)/../chutney; \
  137. else \
  138. echo; \
  139. echo "To run these tests, git clone https://git.torproject.org/chutney.git ; export CHUTNEY_PATH=\`pwd\`/chutney"; \
  140. exit 1; \
  141. fi \
  142. fi
  143. # Note that test-network requires a copy of Chutney in $CHUTNEY_PATH.
  144. # Chutney can be cloned from https://git.torproject.org/chutney.git .
  145. test-network: need-chutney-path $(TESTING_TOR_BINARY) src/tools/tor-gencert
  146. $(top_srcdir)/src/test/test-network.sh $(TEST_NETWORK_FLAGS)
  147. # Run all available tests using automake's test-driver
  148. # only run IPv6 tests if we can ping6 ::1 (localhost)
  149. # only run IPv6 tests if we can ping ::1 (localhost)
  150. # some IPv6 tests will fail without an IPv6 DNS server (see #16971 and #17011)
  151. # only run mixed tests if we have a tor-stable binary
  152. # Try the syntax for BSD ping6, Linux ping6, and Linux ping -6,
  153. # because they're incompatible
  154. test-network-all: need-chutney-path test-driver $(TESTING_TOR_BINARY) src/tools/tor-gencert
  155. mkdir -p $(TEST_NETWORK_ALL_LOG_DIR)
  156. @flavors="$(TEST_CHUTNEY_FLAVORS)"; \
  157. 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 \
  158. echo "ping6 ::1 or ping ::1 succeeded, running IPv6 flavors: $(TEST_CHUTNEY_FLAVORS_IPV6)."; \
  159. flavors="$$flavors $(TEST_CHUTNEY_FLAVORS_IPV6)"; \
  160. else \
  161. echo "ping6 ::1 and ping ::1 failed, skipping IPv6 flavors: $(TEST_CHUTNEY_FLAVORS_IPV6)."; \
  162. skip_flavors="$$skip_flavors $(TEST_CHUTNEY_FLAVORS_IPV6)"; \
  163. fi; \
  164. if command -v tor-stable >/dev/null 2>&1; then \
  165. echo "tor-stable found, running mixed flavors: $(TEST_CHUTNEY_FLAVORS_MIXED)."; \
  166. flavors="$$flavors $(TEST_CHUTNEY_FLAVORS_MIXED)"; \
  167. else \
  168. echo "tor-stable not found, skipping mixed flavors: $(TEST_CHUTNEY_FLAVORS_MIXED)."; \
  169. skip_flavors="$$skip_flavors $(TEST_CHUTNEY_FLAVORS_MIXED)"; \
  170. fi; \
  171. for f in $$skip_flavors; do \
  172. echo "SKIP: $$f"; \
  173. done; \
  174. for f in $$flavors; do \
  175. $(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); \
  176. $(top_srcdir)/src/test/test-network.sh $(TEST_NETWORK_WARNING_FLAGS); \
  177. done; \
  178. echo "Log and result files are available in $(TEST_NETWORK_ALL_LOG_DIR)."; \
  179. ! grep -q FAIL test_network_log/*.trs
  180. need-stem-path:
  181. @if test ! -d "$$STEM_SOURCE_DIR"; then \
  182. echo '$$STEM_SOURCE_DIR was not set.'; echo; \
  183. echo "To run these tests, git clone https://git.torproject.org/stem.git/ ; export STEM_SOURCE_DIR=\`pwd\`/stem"; \
  184. exit 1; \
  185. fi
  186. test-stem: need-stem-path $(TESTING_TOR_BINARY)
  187. @$(PYTHON) "$$STEM_SOURCE_DIR"/run_tests.py --tor "$(TESTING_TOR_BINARY)" --all --log notice --target RUN_ALL;
  188. test-stem-full: need-stem-path $(TESTING_TOR_BINARY)
  189. @$(PYTHON) "$$STEM_SOURCE_DIR"/run_tests.py --tor "$(TESTING_TOR_BINARY)" --all --log notice --target RUN_ALL,ONLINE -v;
  190. test-full: need-stem-path need-chutney-path check test-network test-stem
  191. test-full-online: need-stem-path need-chutney-path check test-network test-stem-full
  192. reset-gcov:
  193. rm -f $(top_builddir)/src/*/*.gcda $(top_builddir)/src/*/*/*.gcda
  194. HTML_COVER_DIR=$(top_builddir)/coverage_html
  195. coverage-html: all
  196. if COVERAGE_ENABLED
  197. test -e "`which lcov`" || (echo "lcov must be installed. See <http://ltp.sourceforge.net/coverage/lcov.php>." && false)
  198. test -d "$(HTML_COVER_DIR)" || $(MKDIR_P) "$(HTML_COVER_DIR)"
  199. lcov --rc lcov_branch_coverage=1 --directory $(top_builddir)/src --zerocounters
  200. $(MAKE) reset-gcov
  201. $(MAKE) check
  202. lcov --capture --rc lcov_branch_coverage=1 --no-external --directory $(top_builddir) --base-directory $(top_srcdir) --output-file "$(HTML_COVER_DIR)/lcov.tmp"
  203. lcov --remove "$(HTML_COVER_DIR)/lcov.tmp" --rc lcov_branch_coverage=1 'test/*' 'ext/tinytest*' '/usr/*' --output-file "$(HTML_COVER_DIR)/lcov.info"
  204. genhtml --branch-coverage -o "$(HTML_COVER_DIR)" "$(HTML_COVER_DIR)/lcov.info"
  205. else
  206. @printf "Not configured with --enable-coverage, run ./configure --enable-coverage\n"
  207. endif
  208. coverage-html-full: all
  209. test -e "`which lcov`" || (echo "lcov must be installed. See <http://ltp.sourceforge.net/coverage/lcov.php>." && false)
  210. test -d "$(HTML_COVER_DIR)" || mkdir -p "$(HTML_COVER_DIR)"
  211. lcov --rc lcov_branch_coverage=1 --directory ./src --zerocounters
  212. $(MAKE) reset-gcov
  213. $(MAKE) check
  214. $(MAKE) test-stem-full
  215. CHUTNEY_TOR=tor-cov CHUTNEY_TOR_GENCERT=tor-cov-gencert $(top_srcdir)/src/test/test-network.sh
  216. CHUTNEY_TOR=tor-cov CHUTNEY_TOR_GENCERT=tor-cov-gencert $(top_srcdir)/src/test/test-network.sh --flavor hs
  217. lcov --capture --rc lcov_branch_coverage=1 --no-external --directory . --output-file "$(HTML_COVER_DIR)/lcov.tmp"
  218. lcov --remove "$(HTML_COVER_DIR)/lcov.tmp" --rc lcov_branch_coverage=1 'test/*' 'ext/tinytest*' '/usr/*' --output-file "$(HTML_COVER_DIR)/lcov.info"
  219. genhtml --branch-coverage -o "$(HTML_COVER_DIR)" "$(HTML_COVER_DIR)/lcov.info"
  220. # Avoid strlcpy.c, strlcat.c, aes.c, OpenBSD_malloc_Linux.c, sha256.c,
  221. # tinytest*.[ch]
  222. check-spaces:
  223. if USE_PERL
  224. $(PERL) $(top_srcdir)/scripts/maint/checkSpace.pl -C \
  225. $(top_srcdir)/src/common/*.[ch] \
  226. $(top_srcdir)/src/or/*.[ch] \
  227. $(top_srcdir)/src/test/*.[ch] \
  228. $(top_srcdir)/src/test/*/*.[ch] \
  229. $(top_srcdir)/src/tools/*.[ch]
  230. endif
  231. check-docs: all
  232. $(PERL) $(top_builddir)/scripts/maint/checkOptionDocs.pl
  233. check-logs:
  234. $(top_srcdir)/scripts/maint/checkLogs.pl \
  235. $(top_srcdir)/src/*/*.[ch] | sort -n
  236. .PHONY: check-typos
  237. check-typos:
  238. @if test -x "`which misspell 2>&1;true`"; then \
  239. echo "Checking for Typos ..."; \
  240. (misspell \
  241. $(top_srcdir)/src/[^e]*/*.[ch] \
  242. $(top_srcdir)/doc \
  243. $(top_srcdir)/contrib \
  244. $(top_srcdir)/scripts \
  245. $(top_srcdir)/README \
  246. $(top_srcdir)/ChangeLog \
  247. $(top_srcdir)/INSTALL \
  248. $(top_srcdir)/ReleaseNotes \
  249. $(top_srcdir)/LICENSE); \
  250. else \
  251. echo "Tor can use misspell to check for typos."; \
  252. echo "It seems that you don't have misspell installed."; \
  253. echo "You can install the latest version of misspell here: https://github.com/client9/misspell#install"; \
  254. fi
  255. .PHONY: clippy
  256. clippy:
  257. if USE_RUST
  258. @if test -x "`which cargo-clippy 2>&1;true`"; then \
  259. echo "Running cargo clippy ..."; \
  260. echo "Prepare yourself for the onslaught of suggestions ..."; \
  261. (cd "$(top_srcdir)/src/rust" && cargo clippy); \
  262. else \
  263. echo "Tor can use clippy to lint Rust code."; \
  264. echo "However, it seems that you don't have clippy installed."; \
  265. echo "You can install the latest version of clippy by following the directions here: https://github.com/rust-lang-nursery/rust-clippy"; \
  266. fi
  267. endif
  268. .PHONY: check-changes
  269. check-changes:
  270. if USEPYTHON
  271. @if test -d "$(top_srcdir)/changes"; then \
  272. $(PYTHON) $(top_srcdir)/scripts/maint/lintChanges.py $(top_srcdir)/changes; \
  273. fi
  274. endif
  275. .PHONY: update-versions
  276. update-versions:
  277. $(PERL) $(top_builddir)/scripts/maint/updateVersions.pl
  278. .PHONY: callgraph
  279. callgraph:
  280. $(top_builddir)/scripts/maint/run_calltool.sh
  281. version:
  282. @echo "Tor @VERSION@"
  283. @if test -d "$(top_srcdir)/.git" && test -x "`which git 2>&1;true`"; then \
  284. echo -n "git: " ;\
  285. (cd "$(top_srcdir)" && git rev-parse --short=16 HEAD); \
  286. fi
  287. mostlyclean-local:
  288. rm -f $(top_builddir)/src/*/*.gc{da,no} $(top_builddir)/src/*/*/*.gc{da,no}
  289. rm -rf $(HTML_COVER_DIR)
  290. rm -rf $(top_builddir)/doc/doxygen
  291. rm -rf $(TEST_NETWORK_ALL_LOG_DIR)
  292. clean-local:
  293. rm -rf $(top_builddir)/src/rust/target
  294. rm -rf $(top_builddir)/src/rust/.cargo/registry
  295. if USE_RUST
  296. distclean-local: distclean-rust
  297. endif
  298. # This relies on some internal details of how automake implements
  299. # distcheck. We check two directories because automake-1.15 changed
  300. # from $(distdir)/_build to $(distdir)/_build/sub.
  301. show-distdir-testlog:
  302. @if test -d "$(distdir)/_build/sub"; then \
  303. cat $(distdir)/_build/sub/$(TEST_SUITE_LOG); \
  304. else \
  305. cat $(distdir)/_build/$(TEST_SUITE_LOG); fi