build.sh

#!/usr/bin/env bash
#
# Wrapper script for MySQL's build.

usage() {
cat <<EOF
Usage: `basename $0` [-b <boost_dir>] [-d <dest_dir>] [-s <server_suffix>] [-t debug|release]
                     [-B 1|0] [-v 1|0] [-D 1|0|default] [-K 1|0]
                     [--asan | --msan | --tsan | --ubsan] [--rocksdb]
       or
       `basename $0` [-h | --help]

  -b                      Set the boost directory.

                          The option is like /usr/local/boost_1_70_0
                          instead of /usr/local/boost_1_70_0/include. 
                          Default: $boost_dir.

  -d                      Set the destination directory. Default: $dest_dir.

  -g                      Turn on unittest (gmock) compilation.

  -s                      Set the server suffix. Default: $server_suffix.

  -t                      Select the build type. Default: $build_type.
                          MySQL defines build type as: Debug, Release, 
                          RelWithDebInfo.  The mapping here is: 
                            debug => Debug
                            release => RelWithDebInfo

  -v                      With or without valgrind. Default: $valgrind.

  -B                      With or without build action. Default: $build_action.

  -D                      With or without debug [for debug sync etc]. 
                          Default: 1 for Debug, 0 for RelWithDebInfo.


  --asan                  Turn on ASAN

  --msan                  Turn on MSAN

  --tsan                  Turn on TSAN

  --ubsan                 Turn on UBSAN

  --rocksdb               Turn on Rocksdb Engin

  -i                      Set git commit

  -h, --help              Show this help message.

Note: this script is intended for internal use by MySQL developers.
EOF
}

check_error() {
  if [ "$?" -ne 0 ]; then
    if [ x"$1" != x"" ]; then
      echo "ERROR: $1"
    fi
    exit 1 
  fi
}

get_option_value() {
  echo "$1" | sed 's/^--[a-zA-Z_-]*=//'
}

parse_options() {
  while test $# -gt 0; do
    case "$1" in
    -b=*)
      boost_dir=`get_option_value "$1"`
    ;;
    -b)
      shift
      boost_dir=`get_option_value "$1"`
    ;;
    -d=*)
      dest_dir=`get_option_value "$1"`
    ;;
    -d)
      shift
      dest_dir=`get_option_value "$1"`
    ;;
    -s=*)
      server_suffix=`get_option_value "$1"`
    ;;
    -s)
      shift
      server_suffix=`get_option_value "$1"`
    ;;
    -g)
      shift
      gmock_enable="1"
    ;;
    -t=*)
      build_type=`get_option_value "$1"`
    ;;
    -t)
      shift
      build_type=`get_option_value "$1"`
    ;;
    -v=*)
      valgrind=`get_option_value "$1"`
    ;;
    -v)
      shift
      valgrind=`get_option_value "$1"`
    ;;
    -B=*)
      build_action=`get_option_value "$1"`
    ;;
    -B)
      shift
      build_action=`get_option_value "$1"`
    ;;
    -D=*)
      debug=`get_option_value "$1"`
    ;;
    -D)
      shift
      debug=`get_option_value "$1"`
    ;;
    --stage1)
      optimize=1
      profile_generate=ON
      profile_use=OFF
      do_bolt=OFF
    ;;
    --stage2)
      optimize=1
      profile_generate=OFF
      profile_use=ON
      do_bolt=OFF
    ;;
    --stage3)
      optimize=1
      profile_generate=OFF
      profile_use=ON
      do_bolt=ON
    ;;
    --asan)
      asan=1
      # AddressSanitizer
      jemalloc=0
    ;;
    --msan)
      msan=1
      # MemorySanitizer
      jemalloc=0
    ;;
    --tsan)
      tsan=1
    ;;
    --ubsan)
      ubsan=1
    ;;
    --rocksdb)
      with_rocksdb=1
    ;;
    -i=*)
	  commit_input=`get_key_value "$1"`
    ;;
	  -i)
	  shift
	  commit_input=`get_key_value "$1"`
    ;;
    --clang)
      clang=1
    ;;
    --jemallocprof)
      with_jemalloc_prof=1
    ;;
    --aarch64_ver=*)
      aarch64_ver=`get_option_value "$1"`
    ;;
    --aarch64_ver)
      shift
      aarch64_ver=`get_option_value "$1"`
		;;
    --arch_type=*)
      arch_type=`get_option_value "$1"`
    ;;
    --arch_type)
      shift
      arch_type=`get_option_value "$1"`
		;;
    -h | --help)
      usage
      exit 0
    ;;
    *)
      echo "Unknown option '$1'"
      exit 1
    ;;
    esac 
    shift 
  done
}

check_options() {
  if [ ! -d "$boost_dir" ]; then
    echo "Boost directory $boost_dir not exists or is not a directory."
    exit 1
  fi

  if [ x"$build_action" != x"1" -a x"$build_action" != x"0" ]; then
    echo "Invalid build_action value, it must be 1 or 0."
    exit 1
  fi

  if [ x"$build_type" = x"debug" ]; then
    cmake_build_type="Debug"
  elif [ x"$build_type" = x"release" ]; then
    cmake_build_type="RelWithDebInfo"
  else
    echo "Invalid build type, it must be \"debug\" or \"release\" or \"none\"."
    exit 1
  fi

  if [ x"$valgrind" != x"1" -a x"$valgrind" != x"0" ]; then
    echo "Invalid valgrind value, it must be 1 or 0."
    exit 1
  fi

  if [ x"$debug" = x"default" ]; then
    if [ x"$cmake_build_type" = x"Debug" ]; then
      debug=1
    elif [ x"$cmake_build_type" = x"RelWithDebInfo" ]; then
      debug=0
    fi
  else
    if [ x"$debug" != x"1" -a x"$debug" != x"0" ]; then
      echo "Invalid debug value, it must be 1, 0, or default."
      exit 1
    fi
  fi

  server_suffix="-""$server_suffix"

  if [ -f "$build_dir" ]; then
    echo "File '$build_dir' exists but it is not a directory."
    exit 1
  fi
}

dump_options() {
  echo "Dumping the options used by $0 ..."
  echo "build_type=$build_type"
  echo "boost_dir=$boost_dir"
  echo "build_action=$build_action"
  echo "dest_dir=$dest_dir"
  echo "server_suffix=$server_suffix"
  echo "valgrind=$valgrind"
  echo "debug=$debug"
  echo "asan=$asan"
  echo "msan=$msan"
  echo "tsan=$tsan"
  echo "ubsan=$ubsan"
  echo "with_rocksdb=$with_rocksdb"
  echo "gmock_zip=$gmock_zip"
}

dump_options_opt() {
  echo "----optimize=$optimize"
  echo "opt_bolt=$opt_bolt do_bolt=$do_bolt"
  echo "with_lto=$with_lto"
  echo "profile_dir=$profile_dir profile_generate=$profile_generate profile_use=$profile_use"
  echo "cmake_cxx_compiler=${cmake_cxx_compiler}"
  echo "cmake_c_compiler=${cmake_c_compiler}"
}

# Default options work well for most devenv, assuming
# it is a Linux box. The bundled boost is with header
# files and prebuilt libraries, but the latter is for
# Linux only. For macOS, should pass the boost built
# by our own. e.g.
#  ./build.sh -b /usr/local/boost_1_70_0
pwd=`pwd`

build_type="debug"
dest_dir="/usr/local/mysql"
server_suffix="txsql"
boost_dir="$pwd/"
tsmdir="$pwd/extra/TencentSM/TencentSM-1.7.3-2"
build_action=1
valgrind=0      # Default, turn-ed off
debug=default   # Default, which means value not set.
asan=0
msan=0
tsan=0
ubsan=0
with_rocksdb=0
jemalloc=1
gmock_zip=""

# compilation optimization
optimize=0
cmake_cxx_compiler=""
cmake_c_compiler=""
opt_bolt=0
with_lto=0
profile_dir=""
profile_generate=0
profile_use=0
do_bolt=0
aarch64_ver=8
arch_type=""

parse_options "$@"

if [ "${gmock_enable}x" == "1x" ];then
  gmock_zip="$pwd/source_downloads/googletest-release-1.10.0.zip"
fi

check_options
dump_options

if [ $with_rocksdb -eq 1 ]; then
  echo "with rocksdb is ON"
  git submodule update --init
fi

if [ $valgrind -eq 1 ]; then
  echo "with valgrind on, turn off jemalloc"
  jemalloc=0
fi

build_dir="bld-$build_type"

if [ ! -d "$build_dir" ]; then
  mkdir "$build_dir"
  check_error
else
  echo "Directory '$build_dir' exists, use it."
  # Remove the caches of cmake, to make sure it will generate files
  # into build directory.
  rm -f CMakeCache.txt
fi

if [ ! -n "$commit_input" ]; then
  git_log=`git log -1 |head -n 1| awk '{print $2}'`
else
  git_log=$commit_input
fi

if [ $clang -eq 1 ]; then
  echo "clang is ON"
  CC=clang
  CXX=clang++
  export CC CXX
fi

cd "$pwd/$build_dir"
check_error

echo "Start to run cmake at `pwd`..."
# For basic options, see official document at:
# https://dev.mysql.com/doc/refman/8.0/en/source-configuration-options.html
# ./cmake/build_configurations/compiler_options.cmake
#
# For customized flags, like:
#  -DCMAKE_C_FLAGS="-m32 -O3"
#  -DCMAKE_CXX_FLAGS="-m32 -O3"
#
# http://russiansecurity.expert/2016/04/20/mysql-connect-file-read/
# https://lightless.me/archives/read-mysql-client-file.html
# Disable local infile by default, also see MySQL manual.
#
# Disable example storage, it not so useful and affects the tests.

which cmake3
if [ "$?" -eq 0 ]
then
  cmk="cmake3"
else
  cmk="cmake"
fi


if [ $optimize -eq 0 ];then
  # normal compile.
  $cmk .. \
    -DFORCE_INSOURCE_BUILD=1                    \
    -DCMAKE_BUILD_TYPE="$cmake_build_type"      \
    -DSYSCONFDIR="$dest_dir"                    \
    -DCMAKE_INSTALL_PREFIX="$dest_dir"          \
    -DMYSQL_DATADIR="$dest_dir/data"            \
    -DWITH_DEBUG=$debug                         \
    -DWITH_VALGRIND=$valgrind                   \
    -DENABLED_PROFILING=1                       \
    -DWITH_EXTRA_CHARSETS=all                   \
    -DWITH_SSL=bundled                           \
    -DWITH_CURL=system                          \
    -DWITH_ENTERPRISE_ENCRYPTION=1              \
    -DWITH_SSL_PATH=/usr/local/ssl              \
    -DWITH_ZLIB=bundled                         \
    -DWITH_BOOST="$boost_dir/boost/"            \
    -DWITH_TSM=${tsmdir}                        \
    -DWITH_INNOBASE_STORAGE_ENGINE=1            \
    -DWITH_ROCKSDB_SE_STORAGE_ENGINE=$with_rocksdb  \
    -DWITH_ARCHIVE_STORAGE_ENGINE=1             \
    -DWITH_BLACKHOLE_STORAGE_ENGINE=1           \
    -DWITH_PERFSCHEMA_STORAGE_ENGINE=1          \
    -DENABLED_LOCAL_INFILE=1                    \
    -DWITH_FEDERATED_STORAGE_ENGINE=1           \
    -DWITH_EXAMPLE_STORAGE_ENGINE=0             \
    -DENABLED_LOCAL_INFILE=0                    \
    -DINSTALL_LAYOUT=STANDALONE                 \
    -DMYSQL_SERVER_SUFFIX="$server_suffix"      \
    -DWITH_ASAN=$asan                           \
    -DWITH_MSAN=$msan                           \
    -DWITH_TSAN=$tsan                           \
    -DWITH_UBSAN=$ubsan                         \
    -DCMAKE_EXPORT_COMPILE_COMMANDS=ON          \
    -DTXSQL_MODE="txsql"                        \
    -DWITH_JEMALLOC=$jemalloc                   \
    -DLOCAL_GMOCK_ZIP="${gmock_zip}" \
    -DGIT_COMMIT="$git_log"\
    -DAARCH64_VER="$aarch64_ver"\
    -DARCH_TYPE="$arch_type"\
    -DCOMPILATION_COMMENT_SERVER="20221230"
else 
  # optimize compilation with lto + pgo + bolt.
  boost_dir="${boost_dir}/boost/boost_1_77_0"
  cmake_cxx_compiler=g++
  cmake_c_compiler=gcc
  opt_bolt=1
  with_lto=ON
  profile_dir="$pwd/profile-data"
  dump_options_opt
  
  $cmk .. \
    -DFORCE_INSOURCE_BUILD=1                    \
    -DCMAKE_BUILD_TYPE="$cmake_build_type"      \
    -DSYSCONFDIR="$dest_dir"                    \
    -DCMAKE_INSTALL_PREFIX="$dest_dir"          \
    -DMYSQL_DATADIR="$dest_dir/data"            \
    -DWITH_DEBUG=$debug                         \
    -DWITH_VALGRIND=$valgrind                   \
    -DENABLED_PROFILING=1                       \
    -DWITH_EXTRA_CHARSETS=all                   \
    -DWITH_SSL=bundled                           \
    -DWITH_CURL=system                          \
    -DWITH_ENTERPRISE_ENCRYPTION=1              \
    -DWITH_SSL_PATH=/usr/local/ssl              \
    -DWITH_ZLIB=bundled                         \
    -DWITH_BOOST="$boost_dir"                   \
    -DWITH_TSM=${tsmdir}                        \
    -DWITH_INNOBASE_STORAGE_ENGINE=1            \
    -DWITH_ROCKSDB_SE_STORAGE_ENGINE=$with_rocksdb  \
    -DWITH_ARCHIVE_STORAGE_ENGINE=1             \
    -DWITH_BLACKHOLE_STORAGE_ENGINE=1           \
    -DWITH_PERFSCHEMA_STORAGE_ENGINE=1          \
    -DENABLED_LOCAL_INFILE=1                    \
    -DWITH_FEDERATED_STORAGE_ENGINE=1           \
    -DWITH_EXAMPLE_STORAGE_ENGINE=0             \
    -DENABLED_LOCAL_INFILE=0                    \
    -DINSTALL_LAYOUT=STANDALONE                 \
    -DMYSQL_SERVER_SUFFIX="$server_suffix"      \
    -DWITH_ASAN=$asan                           \
    -DWITH_MSAN=$msan                           \
    -DWITH_TSAN=$tsan                           \
    -DWITH_UBSAN=$ubsan                         \
    -DCMAKE_EXPORT_COMPILE_COMMANDS=ON          \
    -DTXSQL_MODE="txsql"                        \
    -DOPT_BOLT=$opt_bolt                        \
    -DWITH_LTO=$with_lto                        \
    -DFPROFILE_DIR=$profile_dir                 \
    -DFPROFILE_GENERATE=$profile_generate       \
    -DFPROFILE_USE=$profile_use                 \
    -DDO_BOLT=$do_bolt                          \
    -DCMAKE_CXX_COMPILER=${cmake_cxx_compiler}  \
    -DCMAKE_C_COMPILER=${cmake_c_compiler}      \
    -DWITH_JEMALLOC=$jemalloc                   \
    -DGIT_COMMIT="$git_log"\
    -DAARCH64_VER="$aarch64_ver"\
    -DARCH_TYPE="$arch_type"\
    -DCOMPILATION_COMMENT_SERVER="20221230"
fi


check_error
cd "$pwd"

if [ x"$build_action" = x"1" ]; then
  ncpus=`cat /proc/cpuinfo | grep -c '^processor'`
  unbuffer make VERBOSE=1 -C $build_dir -j$ncpus 2>&1 | tee build.log
fi

#end of file