Makefile.am

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