Skip to content

Latest commit

 

History

History
237 lines (173 loc) · 8.55 KB

BUILDING.md

File metadata and controls

237 lines (173 loc) · 8.55 KB
Raw

Building

Prerequisites (All Platforms)

  • CMake 3.12 or newer
  • C++11 compiler (see platform specific requirements)
  • Doxygen 1.8.11 or greater (for building source documentation)
  • OpenSSL (for building source documentation)
  • Java 8 JDK (for building server side java functions used in some of the integration tests)
  • Apache Geode binaries installed or available to link against
  • Docker (for running SNI Test)
  • Docker Compose (for running SNI Test)

Platform-Specific Prerequisites

Setting Path to Geode

Building requires access to an installation of Geode. There are two ways to achieve this:

  • Set an environment variable called GEODE_HOME that points to your Geode installation path.
  • Pass in GEODE_ROOT during the CMake configuration step.
    • e.g. add -DGEODE_ROOT=/path/to/geode to the initial cmake execution command.

Steps to build

$ cd <clone>
$ mkdir build
$ cd build
# configuration step
$ cmake .. <platform-specific generator parameters (see below)>
# build step
$ cmake --build . -- <platform-specific parallelism parameters (see below)>

If OpenSSL is installed in a custom location, then you must pass OPENSSL_ROOT_DIR during the CMake configuration step. For example, -DOPENSSL_ROOT_DIR=/path/to/openssl.

To explicitly specify the location in which the Native Client will be installed, add -DCMAKE_INSTALL_PREFIX=/path/to/installation/destination to this initial cmake execution command.

To set the version header on the API docs, specify PRODUCT_VERSION on the configuration command line. For example, -DPRODUCT_VERSION=1.2.3.

Generator

CMake uses a "generator" to produce configuration files for use by a variety of build tools, e.g., UNIX makefiles, Visual Studio projects. By default a system-specific generator is used by CMake during configuration. (Please see the CMake documentation for further information.) However, in many cases there is a better choice.

CLion / Eclipse / Other

The recommended generator for most unix platforms is 'Makefiles' (default):

$ cmake ..

Mac OSX Xcode

Install XCode from the App Store

  • You have to run XCode once to get it initialize properly (software agreement).
  • Install the command line tools for xcode - run xcode-select --install from terminal

Install the required dependencies through homebrew. If you use another package manager for your mac feel free to use that.

$ brew install geode
$ brew install openssl
$ brew install doxygen
$ brew install cmake

Follow these steps to build the geode native client. The recommended code generator is Xcode.

$ cd <clone>
$ mkdir build
$ cd build
$ cmake .. -G "Xcode" -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl -DCMAKE_INSTALL_PREFIX=`pwd`/install
$ cmake --build . --target docs
$ cmake --build . --target install -j8

At the end of the process the geode native client will be in the <clone>/build/install directory.

Windows / Visual Studio

When running cmake commands on Windows, be sure to use Visual Studio Native Tools Command Prompt so environment variables are set properly.

The recommended generator on Windows is Visual Studio 15 2017 Win64:

$ cmake .. -G "Visual Studio 15 2017 Win64" -Thost=x64

Visual Studio 2019 is also supported. For this generator you must leave off the Win64:

$ cmake .. -G "Visual Studio 16 2019" -Thost=x64

Build Parallelism

For faster builds, use optional parallelism parameters in the last build step:

Unix

$ cmake --build . -- -j <# of jobs>

Windows

$ cmake --build . -- /m

Optional Configuration

IPv6 support

IPv6 support can be enabled by adding -DWITH_IPV6=ON to the CMake Generator command.

$ cmake … -DWITH_IPV6=ON …

Code Coverage

If building with GCC or Clang you can enable C++ code coverage by adding -DUSE_CPP_COVERAGE=ON to the CMake Generator command.

$ cmake … -DUSE_CPP_COVERAGE=ON …

You can then generate a C++ code coverage report by downloading lcov. After acquiring lcov, finish the Steps to build section above. Then, run the tests as described in the CONTRIBUTING.md. Finally, run the following commands from the build directory:

$ lcov --capture --directory . --output-file coverage.info
$ genhtml coverage.info --output-directory coverage_report

You can then open the index.html file in the coverage_report directory using any browser.

Clang-Tidy

To enable clang-tidy:

$ cmake … -DCMAKE_CXX_CLANG_TIDY=clang-tidy …

To use specific clang-tidy:

$ cmake … -DCMAKE_CXX_CLANG_TIDY=/path/to/clang-tidy …

By default clang-tidy uses the configuration found in .clang-tidy To override clang-tidy options:

$ cmake … -DCMAKE_CXX_CLANG_TIDY=clang-tidy;<options> …

Clang-format

Individual targets in the build tree have their own dependency of the form <<targetName>>-clangformat, which uses the clang-format executable, wherever it is found, to format and modified files according to the rules specfied in the .clang-format file. This is helpful when submitting changes to geode-native, because an improperly formatted file will fail Travis-CI and have to be fixed prior to merging any pull request. If clang-format is not installed on your system, clangformat targets will not be added to your project files, and geode-native should build normally. Under some circumstances, however, it may become necessary to disable clang-format on a system where it is installed.

To disable clang-format in the build:

$ cmake … -DClangFormat_EXECUTABLE='' …

On the other hand, it may also be desirable to run clang-format on the entire source tree. This is also easily done via the all-clangformat in a build with clang-format enabled. If clang-format has been disabled in the cmake configuration step, as above, the all-clangformat target will not exist, and the cmake configuration step will have to be re-run with clang-format enabled.

To run clang-format on the entire source tree:

$ cmake --build . --target all-clangformat

Installing

By default a system-specific location is used by CMake as the destination of the install target, e.g., /usr/local on UNIX system. To explicitly specify the location in which the Native Client will be installed, add -DCMAKE_INSTALL_PREFIX=/path/to/installation/destination to the initial cmake execution command.

Note: For consistent results, avoid using the "~" (tilde) abbreviation when specifying paths on the CMake command line. Interpretation of the symbol varies depending on the option being specified, and on the system or command shell in use.

Due to limitations in CMake, the documentation must be built as a separate step before installation:

$ cd <clone>
$ cd build
$ cmake --build . --target docs
$ cmake --build . --target install

Platform-Specific Prerequisites

Windows

  • Windows 8.1 64-bit
  • Windows 10 64-bit
  • Windows Server 2012 R2 64-bit
  • Windows Server 2016 64-bit
  • NUnit 2.6.4 (to run clicache tests)

Required Tools

Linux

  • RHEL/CentOS 6
  • RHEL/CentOS 7
  • SLES 11
  • SLES 12

Required Tools

Optional Tools

Mac OS X

  • Mac OS X 10.12 (Sierra) or newer
  • Xcode 8.2 or newer

Required Tools

  • Xcode
  • Xcode command line developer tools
$ xcode-select --install

Optional Tools

Solaris

  • Solaris 11 SPARC
  • Solaris 11 x86

Required Tools