Makefile.am 15 KB

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