Skip to content

Latest commit

 

History

History
178 lines (141 loc) · 5.78 KB

BUILD.md

File metadata and controls

178 lines (141 loc) · 5.78 KB
Raw

primecount build instructions

Prerequisites

You need to have installed a C++ compiler which supports C++11 (or later) and CMake ≥ 3.4.

Arch Linux: sudo pacman -S gcc cmake
Debian/Ubuntu: sudo apt install g++ cmake
Fedora: sudo dnf install gcc-c++ cmake
macOS: brew install cmake libomp
openSUSE: sudo zypper install gcc-c++ cmake

Linux & Unix-like OSes

Open a terminal, cd into the primecount directory and run:

cmake .
make -j
sudo make install
sudo ldconfig

macOS

On macOS the default AppleClang C/C++ compiler can be installed using xcode-select --install. If you have installed the homebrew package manager then AppleClang is usually already installed on your Mac.

Open a terminal, cd into the primecount directory and run:

# Install CMake & the OpenMP library
brew install cmake libomp

CXXFLAGS="-I$(brew --prefix libomp)/include" LDFLAGS="-L$(brew --prefix libomp)/lib" cmake ..
make -j
sudo make install

MinGW/MSYS2 (Windows)

Open a terminal, cd into the primecount directory and run:

cmake -G "Unix Makefiles" .
make -j
sudo make install

Microsoft Visual C++

First install Visual Studio (includes CMake) on your Windows PC. Then go to the start menu, select Visual Studio and open a x64 Command Prompt. Now cd into the primecount directory and run the commands below:

# Use 'cmake -G' to find your Visual Studio version
cmake -G "Visual Studio 17 2022" .
cmake --build . --config Release

# Optionally install using Admin shell
cmake --build . --config Release --target install

Run the tests

Open a terminal, cd into the primecount directory and run:

cmake . -DBUILD_TESTS=ON
make -j
ctest

CMake configure options

By default the primecount binary, the static libprimecount and libprimesieve will be built. The build options can be modified at the configure step using e.g. cmake . -DBUILD_TESTS=ON.

option(BUILD_PRIMECOUNT    "Build the primecount binary"           ON)
option(BUILD_LIBPRIMESIEVE "Build libprimesieve"                   ON)
option(BUILD_SHARED_LIBS   "Build the shared libprimecount"        OFF)
option(BUILD_STATIC_LIBS   "Build the static libprimecount"        ON)
option(BUILD_MANPAGE       "Regenerate man page using a2x program" OFF)
option(BUILD_TESTS         "Build the test programs"               OFF)

option(WITH_POPCNT          "Use the POPCNT instruction"            ON)
option(WITH_LIBDIVIDE       "Use libdivide.h"                       ON)
option(WITH_OPENMP          "Enable OpenMP multi-threading"         ON)
option(WITH_DIV32           "Use 32-bit division instead of 64-bit division whenever possible" ON)
option(WITH_MSVC_CRT_STATIC "Link primecount.lib with /MT instead of the default /MD" OFF)
option(WITH_FLOAT128        "Use __float128 (requires libquadmath)" OFF)
option(WITH_JEMALLOC        "Use jemalloc allocator"                OFF)

Packaging primecount

When packaging primecount for e.g. a Linux distro it is best to change a few of the default options.

primecount includes the libprimesieve dependency in its source tree and libprimesieve is built by default. When packaging primecount it is better to install libprimesieve using the package manager and not build libprimesieve from source. You can achieve this using:

  • cmake . -DBUILD_LIBPRIMESIEVE=OFF

By default primecount builds the primecount binary and the static libprimecount. Usually Linux distros don't want to package static libraries. Hence you can build the primecount binary and the shared libprimecount using:

  • cmake . -DBUILD_SHARED_LIBS=ON -DBUILD_STATIC_LIBS=OFF

For performance reasons primecount uses the POPCNT instruction on all CPU architectures that support it. Enabling the POPCNT instruction usually improves primecount's performance by about 30%.

On x86/x64 CPUs primecount will by default detect at build time if the host CPU supports the POPCNT instruction. If not, the POPCNT instruction will be disabled and a portable alternative algorithm will be used. If you need to build a portable primecount binary package for x86/x64 CPUs that can be distributed to many different PCs, even very old ones without POPCNT support (2008 or earlier), you need to disable the POPCNT instruction at build time. Note that disabling POPCNT only has an effect on x86/x64, on other CPU architectures POPCNT is always used if it is available (as this generally does not cause any issues).

  • cmake . -DWITH_POPCNT=OFF

Man page regeneration

primecount includes an up to date man page at doc/primecount.1. That man page has been generated from doc/primecount.txt using the a2x program from the asciidoc package. Usually when packaging primecount it is recommended to regenerate the man page. In order to regenerate the man page you need to install the asciidoc package and then build primecount using cmake . -DBUILD_MANPAGE=ON.

Debian/Ubuntu: sudo apt install asciidoc-base
Fedora: sudo dnf install asciidoc
openSUSE: sudo zypper install asciidoc
Arch Linux: sudo pacman -S asciidoc