Add CMake build system for valkey

[eifrah-aws]

Replacing this PR #1082

NOTE:

This PR was tested on:

• Amazon Linux 2
• Ubuntu 22.04
• AlmaLinux 9
• macOS Sonoma 14.7
• FreeBSD 9 - note on FreeBSD, we require gmake for building valkey

---

With this PR, users are able to build valkey using CMake.

Example usage:

Build valkey-server in Release mode with TLS enabled and using jemalloc as the allocator:

mkdir build-release
cd $_
cmake .. -DCMAKE_BUILD_TYPE=Release \
         -DCMAKE_INSTALL_PREFIX=/tmp/valkey-install \
         -DWITH_MALLOC=jemalloc -DWITH_TLS=1
make -j$(nproc) install

# start valkey
/tmp/valkey-install/bin/valkey-server

Build valkey-unit-tests:

mkdir build-release-ut
cd $_
cmake .. -DCMAKE_BUILD_TYPE=Release \
         -DWITH_MALLOC=jemalloc -DBUILD_TESTS=1
make -j$(nproc)

# Run the tests
./bin/valkey-unit-tests 

Current features supported by this PR:

• Building against different allocators: (jemalloc, tcmalloc, tcmalloc_minimal and libc), e.g. to enable jemalloc pass -DWITH_MALLOC=jemalloc to cmake
• OpenSSL builds (to enable TLS, pass -DWITH_TLS=1 to cmake)
• Sanitizier: pass -DWITH_SANITIZER=<address|thread|undefined> to cmake
• Install target + redis symbolic links
• Build valkey-unit-tests executable
• Standard CMake variables are supported. e.g. to install valkey under /home/you/root pass -DCMAKE_INSTALL_PREFIX=/home/you/root

Why using CMake? To list some of the advantages of using CMake:

• Superior IDE integrations: cmake generates the file compile_commands.json which is required by clangd to get a compiler accuracy code completion (in other words: your VScode will thank you)
• Out of the source build tree: with the current build system, object files are created all over the place polluting the build source tree, the best practice is to build the project on a separate folder
• Multiple build types co-existing: with the current build system, it is often hard to have multiple build configurations. With cmake you can do it easily:
• It is the de-facto standard for C/C++ project these days

More build examples:

ASAN build:

mkdir build-asan
cd $_
cmake .. -DWITH_SANITIZER=address -DWITH_MALLOC=libc
make -j$(nproc)

ASAN with jemalloc:

mkdir build-asan-jemalloc
cd $_
cmake .. -DWITH_SANITIZER=address -DWITH_MALLOC=jemalloc 
make -j$(nproc)

As seen by the previous examples, any combination is allowed and co-exist on the same source tree.

Valkey installation

With this new CMake, it is possible to install the binary by running make install or creating a package make package (currently supported on Debian like distros)

Example 1: build & install using make install:

mkdir build-release
cd $_
cmake .. -DCMAKE_INSTALL_PREFIX=$HOME/valkey-install -DCMAKE_BUILD_TYPE=Release
make -j$(nproc) install
# valkey is now installed under $HOME/valkey-install

Example 2: create a .deb installer:

mkdir build-release
cd $_
cmake .. -DCMAKE_BUILD_TYPE=Release
make -j$(nproc) package
# ... CPack deb generation output
sudo gdebi -n ./valkey_8.1.0_amd64.deb
# valkey is now installed under /opt/valkey

Example 3: create installer for non Debian systems (e.g. FreeBSD or macOS):

mkdir build-release
cd $_
cmake .. -DCMAKE_BUILD_TYPE=Release
make -j$(nproc) package
mkdir -p /opt/valkey && ./valkey-8.1.0-Darwin.sh --prefix=/opt/valkey  --exclude-subdir
# valkey-server is now installed under /opt/valkey

---

Current CMake PR status:

• Targets:
  • valkey-server
  • valkey-cli
  • valkey-benchmark
  • valkey-sentinel
  • RDMA module
  • TLS as module
  • valkey-unit-tests
  • valkey-check-aof
  • valkey-check-rdb
• Features
  • SSL
  • Sanitizer
  • Different allocators (jemalloc, libc, tcmalloc and tcmalloc_minimal)
  • Support .deb packaging
  • Support for script based installer for non debian systems
• Python code generation
  • generate release.h
  • generate commands.def
  • generate fmtargs.h
  • generate test_files.h

[eifrah-aws]

@PingXie see this PR instead.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.69%. Comparing base (2743b7e) to head (f06b624).

Additional details and impacted files

@@             Coverage Diff              @@
##           unstable    #1196      +/-   ##
============================================
- Coverage     70.69%   70.69%   -0.01%     
============================================
  Files           114      114              
  Lines         63076    63076              
============================================
- Hits          44594    44592       -2     
- Misses        18482    18484       +2     

Files with missing lines	Coverage Δ
src/debug.c	53.05% <ø> (ø)
src/server.c	88.77% <ø> (+0.03%)	⬆️

... and 16 files with indirect coverage changes

[pizhenwei]

Is it possible to use WITH_TLS instead of USE_TLS? Then we have a single TLS related building variable.

[PingXie]

Thanks @eifrah-aws

[pizhenwei]

Is it possible to generate config.h by cmake?
I guess this may be the next step.