Building MySQL 8.x - linux-on-ibm-z/docs GitHub Wiki

Building MySQL 8.x

Below versions of MySQL are available in respective distributions at the time creation of these build instructions:

  • RHEL (8.6, 8.8, 8.9) have 8.0.36
  • RHEL (9.0, 9.2, 9.3) have 8.0.36
  • Ubuntu 22.04 has 8.0.36

The instructions provided below specify the steps to build MySQL version 8.3.0 on Linux on IBM Z for the following distributions:

  • RHEL (7.8, 7.9, 8.6, 8.8, 8.9, 9.0, 9.2, 9.3)
  • Ubuntu (22.04)
  • SLES (15 SP5)

General Notes:

  • When following the steps below please use a standard permission user unless otherwise specified.
  • A directory /<source_root>/ will be referred to in these instructions, this is a temporary writable directory anywhere you'd like to place it.

Build MySQL

Step 1: Build using script

If you want to build MySQL using manual steps, go to Step 2. Use the following commands to build MySQL using the build script. Please make sure you have wget installed.

wget -q https://raw.githubusercontent.com/linux-on-ibm-z/scripts/master/MySQL/8.3.0/build_mysql.sh
# Build MySQL
bash build_mysql.sh   [Provide -t option for executing build with tests]

If the build completes successfully, go to STEP 4. In case of error, check logs for more details or go to STEP 2 to follow manual build steps.

Step 2: Install the dependencies

export SOURCE_ROOT=/<source_root>/
export PATCH_URL=https://raw.githubusercontent.com/linux-on-ibm-z/scripts/master/MySQL/8.3.0/patch

2.1) Install the required dependencies

  • RHEL (7.8, 7.9)
    sudo yum install -y make curl wget bison bzip2 gcc gcc-c++ git hostname ncurses-devel pkgconfig tar wget procps zlib-devel doxygen devtoolset-11-gcc devtoolset-11-gcc-c++ devtoolset-11-binutils net-tools cpan perl-JSON perl-Memoize psmisc zip unzip
    sudo PERL_MM_USE_DEFAULT=1 cpan Expect
    sudo yum install -y xz python2 python-yaml     # For Duktape
    export PATH=/opt/rh/devtoolset-11/root/usr/bin:/usr/local/bin:$PATH
    
  • RHEL (8.6, 8.8, 8.9)
    sudo yum install -y curl wget bison bzip2 gcc gcc-c++ git hostname ncurses-devel openssl openssl-devel pkgconfig tar procps wget zlib-devel doxygen cmake diffutils rpcgen make libtirpc-devel libarchive net-tools gcc-toolset-12-gcc gcc-toolset-12-gcc-c++ gcc-toolset-12-binutils gcc-toolset-12-annobin-plugin-gcc cpan perl-JSON perl-Memoize psmisc zip mecab-ipadic
    sudo PERL_MM_USE_DEFAULT=1 cpan Expect
    sudo yum install -y xz python2 python2-pyyaml     # For Duktape
    source /opt/rh/gcc-toolset-12/enable
    
  • RHEL (9.0, 9.2, 9.3)
    sudo yum install -y --allowerasing curl
    sudo yum install -y wget bison bzip2 bzip2-devel gcc gcc-c++ git xz xz-devel hostname ncurses ncurses-devel openssl procps openssl-devel pkgconfig tar wget zlib-devel doxygen cmake diffutils rpcgen make libtirpc-devel libarchive tk-devel gdb gdbm-devel sqlite-devel readline-devel libdb-devel libffi-devel libuuid-devel libnsl2-devel net-tools gcc-toolset-12-gcc gcc-toolset-12-gcc-c++ gcc-toolset-12-binutils gcc-toolset-12-annobin-plugin-gcc cpan perl-JSON perl-Memoize psmisc zip mecab-ipadic
    sudo PERL_MM_USE_DEFAULT=1 cpan Expect
    source /opt/rh/gcc-toolset-12/enable
    
  • Ubuntu (22.04)
    sudo apt-get update
    sudo DEBIAN_FRONTEND=noninteractive apt-get install -y curl wget tar bison cmake gcc g++ git hostname libncurses-dev libssl-dev make openssl pkg-config gawk procps doxygen python-is-python3 python2 net-tools libtirpc-dev libarchive-tools xz-utils libjson-perl libexpect-perl mecab-ipadic-utf8 psmisc zip
    curl https://bootstrap.pypa.io/pip/2.7/get-pip.py --output get-pip.py 
    sudo python2 get-pip.py
    python2 -m pip install --upgrade pip setuptools --force-reinstall
    python2 -m pip install PyYAML==3.13
    
  • SLES (15 SP5)
    sudo zypper install -y curl make cmake bison gcc12 gcc12-c++ git-core hostname ncurses-devel openssl procps openssl-devel pkg-config gawk doxygen libtirpc-devel rpcgen tar wget net-tools-deprecated xz timezone |& tee -a "$LOG_FILE"
    sudo update-alternatives --install /usr/bin/cc cc /usr/bin/gcc-12 12
    sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-12 12
    sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-12 12
    sudo update-alternatives --install /usr/bin/c++ c++ /usr/bin/g++-12 12
    sudo ln -sf /usr/bin/gcc /usr/bin/s390x-linux-gnu-gcc
    sudo ln -sf /usr/bin/cpp-12 /usr/bin/cpp
    

2.2) Install the additional dependencies

  • Build Python 2.7.18 (Only on RHEL 9.x, SLES 15.5)
      cd $SOURCE_ROOT
      wget https://www.python.org/ftp/python/2.7.18/Python-2.7.18.tar.xz
      tar -xvf Python-2.7.18.tar.xz
      cd $SOURCE_ROOT/Python-2.7.18
      ./configure --prefix=/usr/local --exec-prefix=/usr/local
      make
      sudo make install
      sudo ln -sf /usr/local/bin/python /usr/bin/python2
      python2 -V
      # Install pip
      curl https://bootstrap.pypa.io/pip/2.7/get-pip.py --output get-pip.py 
      sudo python2 get-pip.py
      # Install PyYAML for Duktape
      python2 -m pip install --upgrade pip setuptools --force-reinstall
      python2 -m pip install PyYAML==3.13
    
  • Build OpenSSL (Only on RHEL 7.x)
    cd $SOURCE_ROOT
    wget https://www.openssl.org/source/openssl-1.1.1w.tar.gz --no-check-certificate
    tar -xzf openssl-1.1.1w.tar.gz
    cd openssl-1.1.1w
    ./config --prefix=/usr/local --openssldir=/usr/local
    make
    sudo make install
    sudo mkdir -p /usr/local/etc/openssl
    sudo wget https://curl.se/ca/cacert.pem --no-check-certificate -P /usr/local/etc/openssl
    export LDFLAGS="-L/usr/local/lib/ -L/usr/local/lib64/"
    LD_LIBRARY_PATH=/usr/local/lib/:/usr/local/lib64/${LD_LIBRARY_PATH:+:${LD_LIBRARY_PATH}}
    export LD_LIBRARY_PATH
    PKG_CONFIG_PATH=/usr/local/lib/pkgconfig:/usr/local/lib64/pkgconfig${PKG_CONFIG_PATH:+:${PKG_CONFIG_PATH}}
    export PKG_CONFIG_PATH
    LD_RUN_PATH=/usr/local/lib:/usr/local/lib64${LD_RUN_PATH:+:${LD_RUN_PATH}}
    export LD_RUN_PATH
    export CPPFLAGS="-I/usr/local/include/ -I/usr/local/include/openssl"
    export SSL_CERT_FILE=/usr/local/etc/openssl/cacert.pem
    sudo /usr/sbin/ldconfig /usr/local/lib64   # Only on RHEL 7.x
    
  • Build Cmake (Only on RHEL 7.x)
    cd $SOURCE_ROOT
    wget https://github.com/Kitware/CMake/releases/download/v3.20.3/cmake-3.20.3.tar.gz --no-check-certificate
    tar -xvzf cmake-3.20.3.tar.gz
    cd cmake-3.20.3
    ./bootstrap
    make
    sudo make install
    cmake --version
    
  • Build Duktape
    cd $SOURCE_ROOT
    wget https://duktape.org/duktape-2.7.0.tar.xz     # Use wget with `--no-check-certificate` on RHEL 7.x
    tar xfJ duktape-2.7.0.tar.xz
    cd duktape-2.7.0
    # Add s390x related code changes
    sed -i '/\/* Durango (Xbox One)/i \/* s390x *\/\n#if defined(__s390x__)\n#define DUK_F_S390X \n#endif' src/duk_config.h
    sed -i '/#elif defined(DUK_F_SPARC32)/i #elif defined(DUK_F_S390X)\n\/* --- s390x --- *\/\n#define DUK_USE_ARCH_STRING "s390x"\n#define DUK_USE_BYTEORDER 3\n#undef DUK_USE_PACKED_TVAL\n#define DUK_F_PACKED_TVAL_PROVIDED'  src/duk_config.h 
    sed -i 's/duk_memcpy_unsafe((void \*) p, (const void \*) ins, (size_t) (ins_end - ins));/duk_memcpy_unsafe((void *) p, (const void *) ins, (size_t) (ins_end - ins) * 4);/' src-input/duk_api_bytecode.c 
    sed -i 's/p += (size_t) (ins_end - ins);/p += (size_t) (ins_end - ins) * 4;/' src-input/duk_api_bytecode.c
    python2 tools/configure.py --output-directory src-duktape
    

Step 3: Product Build - MySQL

3.1) Download the MySQL source code

cd $SOURCE_ROOT
git clone https://github.com/mysql/mysql-server.git
cd mysql-server
git checkout mysql-8.3.0
curl -sSL "${PATCH_URL}/mt-asm.patch" | git apply -
curl -sSL "${PATCH_URL}/NdbHW.patch" | git apply -
curl -sSL "${PATCH_URL}/router-test.patch" | git apply -
curl -sSL "${PATCH_URL}/icu-cmake.patch" | git apply -
curl -sSL "${PATCH_URL}/floating-point-cmake.patch" | git apply -
curl -sSL "${PATCH_URL}/ut0rnd.patch" | git apply -
# Copy Duktape files
rm $SOURCE_ROOT/mysql-server/extra/duktape/duktape-2.7.0/src/*
cp $SOURCE_ROOT/duktape-2.7.0/src-duktape/* $SOURCE_ROOT/mysql-server/extra/duktape/duktape-2.7.0/src/
mkdir build
cd build

3.2) Configure, Build and Install MySQL

  • RHEL 7.x
    wget https://boostorg.jfrog.io/artifactory/main/release/1.77.0/source/boost_1_77_0.tar.bz2
    cmake .. -DDOWNLOAD_BOOST=0 -DWITH_BOOST=$SOURCE_ROOT/mysql-server/build -DWITH_SSL=system -DCMAKE_C_COMPILER=/opt/rh/devtoolset-11/root/bin/gcc -DCMAKE_CXX_COMPILER=/opt/rh/devtoolset-11/root/bin/g++
    make -j $(nproc)
    sudo make install   
    
  • RHEL(8.x, 9.x), Ubuntu(22.04), SLES (15 SP5)
    cmake .. -DDOWNLOAD_BOOST=1 -DWITH_BOOST=. -DWITH_SSL=system
    make -j $(nproc)
    sudo make install
    
    Note: For more MySQL source configuration options, please visit their official guide.

3.3) Run unit tests (Optional)

  • Use the below commands to run the unit test suite:
cd $SOURCE_ROOT/mysql-server/build
export LD_PRELOAD=$SOURCE_ROOT/mysql-server/build/library_output_directory/libprotobuf-lite.so.3.19.4:$LD_PRELOAD   # To fix routertest test failures
make test
  • Use the below command to run an individual test case (for example routertest_component_routing_splicer):
ctest -VV -R routertest_component_routing_splicer

3.4) Run integration tests (Optional)

  • Use the below commands to run the integration test suite:
# Temporarily change permissions of install dirs that tests write to.
sudo chmod -f 777 /usr/local/mysql/bin /usr/local/mysql/lib/plugin
mkdir -p $SOURCE_ROOT/mysql-test/var/tmp
cd /usr/local/mysql/mysql-test/
# Skip the main.file_contents test because the docs dir path hardcoded in the test is broken when mysql is installed under /usr
./mysql-test-run.pl --vardir=${SOURCE_ROOT}/mysql-test/var --tmpdir=${SOURCE_ROOT}/mysql-test/var/tmp --suite=main --force --skip-test=file_contents
sudo chmod -f 755 /usr/local/mysql/bin /usr/local/mysql/lib/plugin
  • Use the below commands to run an individual test case (for example main.slow_log):
sudo chmod -f 777 /usr/local/mysql/bin /usr/local/mysql/lib/plugin
./mysql-test-run.pl --vardir=${SOURCE_ROOT}/mysql-test/var --tmpdir=${SOURCE_ROOT}/mysql-test/var/tmp --suite=main main.slow_log
sudo chmod -f 755 /usr/local/mysql/bin /usr/local/mysql/lib/plugin

Note:

  • Below test cases are failing for both intel and s390x:
    • In unit tests : routertest_component_router_stacktrace
    • In integration tests : main.loaddata_special
  • Below test cases might fail if IPv6 is not enabled:
    • NdbGetInAddr-t
    • routertest_harness_net_ts_internet
    • routertest_component_http_server

Step 4: Post installation Setup and Testing (Optional)

Refer to this guide for the Postinstallation Setup and Testing overview.

References: