Compiling KPHP from sources

KPHP can be compiled for Debian systems. Public builds are available for Buster and Ubuntu.

We have not tested if KPHP can be compiled for a non-Debian system. If you have luck, please let us know.

Where all sources are located

All KPHP sources are on GitHub, distributed under the GPLv3 license.
These are sources of KPHP, vkext, flex data (for Russian declensions), and all TL tools. All significant dependencies are managed as Git submodules.

KPHP linkage depends on some custom packages, that are also compiled from source:

  • epoll implementation for MacOS on GitHub (branch osx-platform)

KPHP is compiled with CMake and packed with CPack.

Prerequisites

Debian 10 (Buster)

Add external repositories

apt-get update
# utils for adding repositories
apt-get install -y --no-install-recommends apt-utils ca-certificates gnupg wget lsb-release
# for newest cmake package
echo "deb https://archive.debian.org/debian buster-backports main" >> /etc/apt/sources.list
# for php7.4-dev package
wget -qO - https://debian.octopuce.fr/snapshots/sury-php/buster-latest/apt.gpg | apt-key add -
echo "deb https://debian.octopuce.fr/snapshots/sury-php/buster-latest/ buster main" >> /etc/apt/sources.list.d/php.list
# for libmysqlclient-dev
TEMP_DEB="$(mktemp)"
wget -O "$TEMP_DEB" 'https://dev.mysql.com/get/mysql-apt-config_0.8.20-1_all.deb'
DEBIAN_FRONTEND=noninteractive dpkg -i "$TEMP_DEB"
rm -f "$TEMP_DEB"
# for postgresql 
echo "deb https://apt-archive.postgresql.org/pub/repos/apt buster-pgdg-archive main" > /etc/apt/sources.list.d/pgdg.list
wget -qO - https://www.postgresql.org/media/keys/ACCC4CF8.asc | apt-key add -

Install packages

apt-get update
apt install git cmake-data=3.18* cmake=3.18* make patch re2c g++ gperf python3-minimal python3-jsonschema python3-six \
            libfmt-dev libgtest-dev libgmock-dev \
            zlib1g-dev php7.4-dev libldap-dev libkrb5-dev \
            libpq5=14.* postgresql-14 postgresql-server-dev-14 libpq-dev=14.* composer
Ubuntu 20.04 (Focal Fossa)

Add external repositories

apt-get update
# utils for adding repositories
apt-get install -y --no-install-recommends apt-utils ca-certificates gnupg wget pkg-config software-properties-common
# for postgresql
echo "deb https://apt-archive.postgresql.org/pub/repos/apt focal-pgdg-archive main" > /etc/apt/sources.list.d/pgdg.list 
wget -qO - https://www.postgresql.org/media/keys/ACCC4CF8.asc | apt-key add - 
# for python package
add-apt-repository ppa:deadsnakes/ppa 
apt-get update

Install packages

apt-get update
apt install git cmake make g++ gperf netcat patch re2c \
            python3.7 python3-pip python3.7-distutils python3.7-dev libpython3.7-dev python3-jsonschema python3-setuptools python3-six \
            libfmt-dev libgtest-dev libgmock-dev \
            zlib1g-dev php7.4-dev libldap-dev libkrb5-dev mysql-server libmysqlclient-dev \
            libpq5=14.* postgresql-14 postgresql-server-dev-14 libpq-dev=14.* composer
MacOS

Make sure you have brew and clang (at least Apple clang version 10.0.0)

# Install dependencies
brew tap shivammathur/php
brew update
brew install python@3.13 re2c cmake coreutils libiconv googletest shivammathur/php/php@7.4
brew link --overwrite shivammathur/php/php@7.4
python3.13 -m pip install jsonschema six

# Build kphp
git clone https://github.com/VKCOM/kphp.git && cd kphp
mkdir build && cd build
cmake .. -DDOWNLOAD_MISSING_LIBRARIES=On
make -j$(nproc)
Other Linux

Make sure you are using the same package list.

Recommendations

It's also recommended having a libfmt >= 7 installed (if not, pass -DDOWNLOAD_MISSING_LIBRARIES=On to CMake) and ccache, it may speed up compilation time.

CMake configuration

Here are available variables, that can be modified during the cmake invocation:

DOWNLOAD_MISSING_LIBRARIES when libfmt / gtest / epoll-shim / etc not found, downloads them to a local folder [Off]
ADDRESS_SANITIZER enables the address sanitizer [Off]
UNDEFINED_SANITIZER enables the undefined sanitizer [Off]
KPHP_TESTS include tests to default target [On]

Compiling KPHP

We use the make command here, but of course, parallel compilation means make -j$(nproc) or env settings.

mkdir build
cd build
cmake ..
make

Compiling tl2php and other tools

This is achieved with the same command:

# in build/ folder
make

Compiling vkext

To build and install vkext locally, you need to have php and php-dev packages installed for PHP 7.2 or above.
vkext is also compiled with CMake.

# in build/ folder
make

Install for the default PHP version (recommended)

sudo cp ../objs/vkext/modules/vkext.so $(php-config --extension-dir)

If you want to use it everywhere, update the global php.ini file by adding the following lines:

extension=vkext.so
tl.conffile="/path/to/scheme.tlo"

If you don't want to install it globally, pass it as the -d option to php instead of updating php.ini:

php -d extension=vkext.so -d tl.conffile=/path/to/scheme.tlo ...

Build for a specific PHP version (optional)

Run the following script with the desirable PHP_VERSION (only “7.2” and “7.4” are supported so far):

# in build/ folder
make vkext${PHP_VERSION}
sudo cp ../objs/vkext/modules${PHP_VERSION}/vkext.so $(php-config${PHP_VERSION} --extension-dir)

Compiling .tlo for php.ini

Use the tl-compiler executable from vk-tl-tools package:

tl-compiler -e /path/to/output.tlo input1.tl input2.tl ...

Building a .deb package

# in build/ folder
cpack -D CPACK_COMPONENTS_ALL="KPHP;FLEX" .