David Benjamin 301afaf223 Add a run_tests target to run all tests.

It's very annoying having to remember the right incant every time I want
to switch around between my build, build-release, build-asan, etc.,
output directories.

Unfortunately, this target is pretty unfriendly without CMake 3.2+ (and
Ninja 1.5+). This combination gives a USES_TERMINAL flag to
add_custom_target which uses Ninja's "console" pool, otherwise the
output buffering gets in the way. Ubuntu LTS is still on an older CMake,
so do a version check in the meantime.

CMake also has its own test mechanism (CTest), but this doesn't use it.
It seems to prefer knowing what all the tests are and then tries to do
its own output management and parallelizing and such. We already have
our own runners. all_tests.go could actually be converted tidily, but
generate_build_files.py also needs to read it, and runner.go has very
specific needs.

Naming the target ninja -C build test would be nice, but CTest squats
that name and CMake grumps when you use a reserved name, so I've gone
with run_tests.

Change-Id: Ibd20ebd50febe1b4e91bb19921f3bbbd9fbcf66c
Reviewed-on: https://boringssl-review.googlesource.com/6270
Reviewed-by: Adam Langley <alangley@gmail.com>

2015-10-26 20:33:44 +00:00

5.0 KiB

Raw Blame History

Building BoringSSL

Build Prerequisites

[CMake] 1 2.8.8 or later is required.
Perl 5.6.1 or later is required. On Windows, [Strawberry Perl] 2 and MSYS Perl have both been reported to work. If not found by CMake, it may be configured explicitly by setting PERL_EXECUTABLE.
On Windows you currently must use [Ninja] 3 to build; on other platforms, it is not required, but recommended, because it makes builds faster.
If you need to build Ninja from source, then a recent version of [Python] 4 is required (Python 2.7.5 works).
On Windows only, [Yasm] 5 is required. If not found by CMake, it may be configured explicitly by setting CMAKE_ASM_NASM_COMPILER.
A C compiler is required. On Windows, MSVC 12 (Visual Studio 2013) or later with Platform SDK 8.1 or later are supported. Recent versions of GCC and Clang should work on non-Windows platforms, and maybe on Windows too.
[Go] 6 is required. If not found by CMake, the go executable may be configured explicitly by setting GO_EXECUTABLE.

Building

Using Ninja (note the 'N' is capitalized in the cmake invocation):

mkdir build
cd build
cmake -GNinja ..
ninja

Using Make (does not work on Windows):

mkdir build
cd build
cmake ..
make

You usually don't need to run cmake again after changing CMakeLists.txt files because the build scripts will detect changes to them and rebuild themselves automatically.

Note that the default build flags in the top-level CMakeLists.txt are for debugging—optimisation isn't enabled.

If you want to cross-compile then there is an example toolchain file for 32-bit Intel in util/. Wipe out the build directory, recreate it and run cmake like this:

cmake -DCMAKE_TOOLCHAIN_FILE=../util/32-bit-toolchain.cmake -GNinja ..

If you want to build as a shared library, pass -DBUILD_SHARED_LIBS=1. On Windows, where functions need to be tagged with dllimport when coming from a shared library, define BORINGSSL_SHARED_LIBRARY in any code which #includes the BoringSSL headers.

Building for Android

It's possible to build BoringSSL with the Android NDK using CMake. This has been tested with version 10d of the NDK.

Unpack the Android NDK somewhere and export ANDROID_NDK to point to the directory. Clone https://github.com/taka-no-me/android-cmake into util/. Then make a build directory as above and run CMake twice like this:

cmake -DANDROID_NATIVE_API_LEVEL=android-9 \
      -DANDROID_ABI=armeabi-v7a \
      -DCMAKE_TOOLCHAIN_FILE=../util/android-cmake/android.toolchain.cmake \
      -DANDROID_NATIVE_API_LEVEL=16 \
      -GNinja ..

Once you've run that twice, Ninja should produce Android-compatible binaries. You can replace armeabi-v7a in the above with arm64-v8a to build aarch64 binaries.

Known Limitations on Windows

Versions of CMake since 3.0.2 have a bug in its Ninja generator that causes yasm to output warnings
```
yasm: warning: can open only one input file, only the last file will be processed
```
These warnings can be safely ignored. The cmake bug is http://www.cmake.org/Bug/view.php?id=15253.
CMake can generate Visual Studio projects, but the generated project files don't have steps for assembling the assembly language source files, so they currently cannot be used to build BoringSSL.

Embedded ARM

ARM, unlike Intel, does not have an instruction that allows applications to discover the capabilities of the processor. Instead, the capability information has to be provided by the operating system somehow.

BoringSSL will try to use getauxval to discover the capabilities and, failing that, will probe for NEON support by executing a NEON instruction and handling any illegal-instruction signal. But some environments don't support that sort of thing and, for them, it's possible to configure the CPU capabilities at compile time.

If you define OPENSSL_STATIC_ARMCAP then you can define any of the following to enabling the corresponding ARM feature.

OPENSSL_STATIC_ARMCAP_NEON or __ARM_NEON__ (note that the latter is set by compilers when NEON support is enabled).
OPENSSL_STATIC_ARMCAP_AES
OPENSSL_STATIC_ARMCAP_SHA1
OPENSSL_STATIC_ARMCAP_SHA256
OPENSSL_STATIC_ARMCAP_PMULL

Note that if a feature is enabled in this way, but not actually supported at run-time, BoringSSL will likely crash.

Running tests

There are two sets of tests: the C/C++ tests and the blackbox tests. For former are built by Ninja and can be run from the top-level directory with go run util/all_tests.go. The latter have to be run separately by running go test from within ssl/test/runner.

Both sets of tests may also be run with ninja -C build run_tests, but CMake 3.2 or later is required to avoid Ninja's output buffering.

5.0 KiB Raw Blame History