mirror of
https://github.com/MariaDB/server.git
synced 2025-01-15 19:42:28 +01:00
031f11717d
The easiest way to compile and test the server with UBSAN is to run: ./BUILD/compile-pentium64-ubsan and then run mysql-test-run. After this commit, one should be able to run this without any UBSAN warnings. There is still a few compiler warnings that should be fixed at some point, but these do not expose any real bugs. The 'special' cases where we disable, suppress or circumvent UBSAN are: - ref10 source (as here we intentionally do some shifts that UBSAN complains about. - x86 version of optimized int#korr() methods. UBSAN do not like unaligned memory access of integers. Fixed by using byte_order_generic.h when compiling with UBSAN - We use smaller thread stack with ASAN and UBSAN, which forced me to disable a few tests that prints the thread stack size. - Verifying class types does not work for shared libraries. I added suppression in mysql-test-run.pl for this case. - Added '#ifdef WITH_UBSAN' when using integer arithmetic where it is safe to have overflows (two cases, in item_func.cc). Things fixed: - Don't left shift signed values (byte_order_generic.h, mysqltest.c, item_sum.cc and many more) - Don't assign not non existing values to enum variables. - Ensure that bool and enum values are properly initialized in constructors. This was needed as UBSAN checks that these types has correct values when one copies an object. (gcalc_tools.h, ha_partition.cc, item_sum.cc, partition_element.h ...) - Ensure we do not called handler functions on unallocated objects or deleted objects. (events.cc, sql_acl.cc). - Fixed bugs in Item_sp::Item_sp() where we did not call constructor on Query_arena object. - Fixed several cast of objects to an incompatible class! (Item.cc, Item_buff.cc, item_timefunc.cc, opt_subselect.cc, sql_acl.cc, sql_select.cc ...) - Ensure we do not do integer arithmetic that causes over or underflows. This includes also ++ and -- of integers. (Item_func.cc, Item_strfunc.cc, item_timefunc.cc, sql_base.cc ...) - Added JSON_VALUE_UNITIALIZED to json_value_types and ensure that value_type is initialized to this instead of to -1, which is not a valid enum value for json_value_types. - Ensure we do not call memcpy() when second argument could be null. - Fixed that Item_func_str::make_empty_result() creates an empty string instead of a null string (safer as it ensures we do not do arithmetic on null strings). Other things: - Changed struct st_position to an OBJECT and added an initialization function to it to ensure that we do not copy or use uninitialized members. The change to a class was also motived that we used "struct st_position" and POSITION randomly trough the code which was confusing. - Notably big rewrite in sql_acl.cc to avoid using deleted objects. - Changed in sql_partition to use '^' instead of '-'. This is safe as the operator is either 0 or 0x8000000000000000ULL. - Added check for select_nr < INT_MAX in JOIN::build_explain() to avoid bug when get_select() could return NULL. - Reordered elements in POSITION for better alignment. - Changed sql_test.cc::print_plan() to use pointers instead of objects. - Fixed bug in find_set() where could could execute '1 << -1'. - Added variable have_sanitizer, used by mtr. (This variable was before only in 10.5 and up). It can now have one of two values: ASAN or UBSAN. - Moved ~Archive_share() from ha_archive.cc to ha_archive.h and marked it virtual. This was an effort to get UBSAN to work with loaded storage engines. I kept the change as the new place is better. - Added in CONNECT engine COLBLK::SetName(), to get around a wrong cast in tabutil.cpp. - Added HAVE_REPLICATION around usage of rgi_slave, to get embedded server to compile with UBSAN. (Patch from Marko). - Added #ifdef for powerpc64 to avoid a bug in old gcc versions related to integer arithmetic. Changes that should not be needed but had to be done to suppress warnings from UBSAN: - Added static_cast<<uint16_t>> around shift to get rid of a LOT of compiler warnings when using UBSAN. - Had to change some '/' of 2 base integers to shift to get rid of some compile time warnings. Reviewed by: - Json changes: Alexey Botchkov - Charset changes in ctype-uca.c: Alexander Barkov - InnoDB changes & Embedded server: Marko Mäkelä - sql_acl.cc changes: Vicențiu Ciorbaru - build_explain() changes: Sergey Petrunia
323 lines
9.9 KiB
Bash
Executable file
323 lines
9.9 KiB
Bash
Executable file
#!/bin/sh
|
|
|
|
# Copyright (c) 2000, 2011, Oracle and/or its affiliates. All rights reserved.
|
|
#
|
|
# This program is free software; you can redistribute it and/or
|
|
# modify it under the terms of the GNU Library General Public
|
|
# License as published by the Free Software Foundation; version 2
|
|
# of the License.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
# Library General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Library General Public
|
|
# License along with this library; if not, write to the Free
|
|
# Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
|
|
# MA 02110-1335 USA
|
|
|
|
########################################################################
|
|
|
|
get_key_value()
|
|
{
|
|
echo "$1" | sed 's/^--[a-zA-Z_-]*=//'
|
|
}
|
|
|
|
usage()
|
|
{
|
|
cat <<EOF
|
|
Usage: $0 [-h|-n] [configure-options]
|
|
-h, --help Show this help message.
|
|
-n, --just-print Don't actually run any commands; just print them.
|
|
-c, --just-configure Stop after running configure.
|
|
Combined with --just-print shows configure options.
|
|
--extra-configs=xxx Add this to configure options
|
|
--extra-flags=xxx Add this C and CXX flags
|
|
--extra-cflags=xxx Add this to C flags
|
|
--extra-cxxflags=xxx Add this to CXX flags
|
|
--verbose Print out full compile lines
|
|
--with-debug=full Build with full debug(no optimizations, keep call stack).
|
|
--warning-mode=[old|pedantic|maintainer]
|
|
Influences the debug flags. Old is default.
|
|
--prefix=path Build with prefix 'path'.
|
|
|
|
Note: this script is intended for internal use by MariaDB developers.
|
|
EOF
|
|
}
|
|
|
|
parse_options()
|
|
{
|
|
while test $# -gt 0
|
|
do
|
|
case "$1" in
|
|
--prefix=*)
|
|
prefix=`get_key_value "$1"`;;
|
|
--with-debug=full)
|
|
full_debug="=full";;
|
|
--warning-mode=*)
|
|
warning_mode=`get_key_value "$1"`;;
|
|
--extra-flags=*)
|
|
EXTRA_FLAGS=`get_key_value "$1"`;;
|
|
--extra-cflags=*)
|
|
EXTRA_CFLAGS=`get_key_value "$1"`;;
|
|
--extra-cxxflags=*)
|
|
EXTRA_CXXFLAGS=`get_key_value "$1"`;;
|
|
--extra-configs=*)
|
|
EXTRA_CONFIGS=`get_key_value "$1"`;;
|
|
--extra-makeflags=*)
|
|
EXTRA_MAKEFLAGS=`get_key_value "$1"`;;
|
|
-c | --just-configure)
|
|
just_configure=1;;
|
|
-n | --just-print | --print)
|
|
just_print=1;;
|
|
--verbose)
|
|
verbose_make=1;;
|
|
-h | --help)
|
|
usage
|
|
exit 0;;
|
|
*)
|
|
echo "Unknown option '$1'"
|
|
exit 1;;
|
|
esac
|
|
shift
|
|
done
|
|
}
|
|
|
|
########################################################################
|
|
|
|
if test ! -f sql/mysqld.cc
|
|
then
|
|
echo "You must run this script from the MySQL top-level directory"
|
|
exit 1
|
|
fi
|
|
|
|
prefix="/usr/local/mysql"
|
|
just_print=
|
|
just_configure=
|
|
warning_mode=
|
|
maintainer_mode=
|
|
full_debug=
|
|
verbose_make=
|
|
|
|
parse_options "$@"
|
|
|
|
if test -n "$MYSQL_BUILD_PREFIX"
|
|
then
|
|
prefix="$MYSQL_BUILD_PREFIX"
|
|
fi
|
|
|
|
set -e
|
|
|
|
#
|
|
# Check for the CPU and set up CPU specific flags. We may reset them
|
|
# later.
|
|
#
|
|
path=`dirname $0`
|
|
. "$path/check-cpu"
|
|
. "$path/util.sh"
|
|
|
|
get_make_parallel_flag
|
|
|
|
# SSL library to use.--with-ssl will select our bundled yaSSL
|
|
# implementation of SSL. --with-ssl=yes will first try system library
|
|
# then the boundled one --with-ssl=system will use the system library.
|
|
# We use bundled by default as this is guaranteed to work with Galera
|
|
SSL_LIBRARY=--with-ssl
|
|
|
|
if [ "x$warning_mode" = "xpedantic" ]; then
|
|
warnings="-W -Wall -ansi -pedantic -Wno-long-long -Wno-unused -D_POSIX_SOURCE"
|
|
c_warnings="$warnings"
|
|
cxx_warnings="$warnings -std=c++98"
|
|
# NOTE: warning mode should not influence optimize/debug mode.
|
|
# Please feel free to add a separate option if you don't feel it's an overkill.
|
|
debug_extra_cflags="-O0"
|
|
# Reset CPU flags (-mtune), they don't work in -pedantic mode
|
|
check_cpu_cflags=""
|
|
elif [ "x$warning_mode" = "xmaintainer" ]; then
|
|
c_warnings="-Wall -Wextra"
|
|
cxx_warnings="$c_warnings -Wno-unused-parameter"
|
|
maintainer_mode="--enable-mysql-maintainer-mode"
|
|
debug_extra_cflags="-g3"
|
|
else
|
|
# Both C and C++ warnings
|
|
warnings="-Wall -Wextra -Wunused -Wwrite-strings -Wno-uninitialized -Wno-strict-aliasing -Wimplicit-fallthrough=2 -Wformat-security -Wvla"
|
|
|
|
# For more warnings, uncomment the following line
|
|
# warnings="$warnings -Wshadow"
|
|
|
|
# C warnings
|
|
c_warnings="$warnings"
|
|
# C++ warnings
|
|
cxx_warnings="$warnings -Wno-unused-parameter -Wno-invalid-offsetof"
|
|
# cxx_warnings="$cxx_warnings -Woverloaded-virtual -Wsign-promo"
|
|
cxx_warnings="$cxx_warnings -Wnon-virtual-dtor"
|
|
debug_extra_cflags="-O0 -g3 -gdwarf-2"
|
|
fi
|
|
|
|
# Set flags for various build configurations.
|
|
# Used in -valgrind builds
|
|
# Override -DFORCE_INIT_OF_VARS from debug_cflags. It enables the macro
|
|
# UNINIT_VAR(), which is only useful for silencing spurious warnings
|
|
# of static analysis tools. We want UNINIT_VAR() to be a no-op in Valgrind.
|
|
# TRASH_FREE_MEMORY is enabled so that we can find wrong memory accesses
|
|
# even when running a test without valgrind
|
|
#
|
|
valgrind_flags="-DHAVE_valgrind -USAFEMALLOC -DTRASH_FREE_MEMORY"
|
|
valgrind_flags="$valgrind_flags -UFORCE_INIT_OF_VARS -Wno-uninitialized"
|
|
valgrind_flags="$valgrind_flags -DMYSQL_SERVER_SUFFIX=-valgrind-max"
|
|
valgrind_configs="--with-valgrind"
|
|
#
|
|
# Used in -debug builds
|
|
debug_cflags="-DEXTRA_DEBUG -DSAFE_MUTEX -DSAFEMALLOC"
|
|
error_inject="--with-error-inject "
|
|
#
|
|
# Base C++ flags for all builds
|
|
base_cxxflags="-felide-constructors -fexceptions"
|
|
#
|
|
# Flags for optimizing builds.
|
|
# Be as fast as we can be without losing our ability to backtrace.
|
|
fast_cflags="-O3 -fno-omit-frame-pointer"
|
|
|
|
debug_configs="--with-debug"
|
|
if [ -z "$full_debug" ]
|
|
then
|
|
debug_cflags="$debug_cflags $debug_extra_cflags"
|
|
fi
|
|
|
|
# we need local-infile in all binaries for rpl000001
|
|
# if you need to disable local-infile in the client, write a build script
|
|
# and unset local_infile_configs
|
|
local_infile_configs="--enable-local-infile"
|
|
|
|
#
|
|
# Configuration options.
|
|
#
|
|
base_configs="--prefix=$prefix --enable-assembler "
|
|
base_configs="$base_configs --with-extra-charsets=complex "
|
|
base_configs="$base_configs --enable-thread-safe-client "
|
|
base_configs="$base_configs --with-big-tables $maintainer_mode"
|
|
base_configs="$base_configs --with-plugin-aria --with-aria-tmp-tables"
|
|
# Following is to get tokudb to work
|
|
base_configs="$base_configs --with-jemalloc=NO"
|
|
|
|
if test -d "$path/../cmd-line-utils/readline"
|
|
then
|
|
base_configs="$base_configs --with-readline"
|
|
elif test -d "$path/../cmd-line-utils/libedit"
|
|
then
|
|
base_configs="$base_configs --with-libedit"
|
|
fi
|
|
|
|
max_no_embedded_configs="$SSL_LIBRARY --with-plugins=max"
|
|
max_no_qc_configs="$SSL_LIBRARY --with-plugins=max --without-query-cache"
|
|
max_configs="$SSL_LIBRARY --with-plugins=max --with-embedded-server --with-libevent --without-plugin=plugin_file_key_management --with-plugin-rocksdb=dynamic --with-plugin-test_sql_discovery=DYNAMIC --with-plugin-file_key_management=DYNAMIC"
|
|
all_configs="$SSL_LIBRARY --with-plugins=max --with-embedded-server --with-innodb_plugin --with-libevent"
|
|
|
|
#
|
|
# CPU and platform specific compilation flags.
|
|
#
|
|
alpha_cflags="$check_cpu_cflags -Wa,-m$cpu_flag"
|
|
amd64_cflags="$check_cpu_cflags"
|
|
amd64_cxxflags="" # If dropping '--with-big-tables', add here "-DBIG_TABLES"
|
|
pentium_cflags="$check_cpu_cflags -m32"
|
|
pentium64_cflags="$check_cpu_cflags -m64"
|
|
ppc_cflags="$check_cpu_cflags"
|
|
sparc_cflags=""
|
|
|
|
if gmake --version > /dev/null 2>&1
|
|
then
|
|
make=gmake
|
|
else
|
|
make=make
|
|
fi
|
|
|
|
if test -z "$CC" ; then
|
|
CC=gcc
|
|
fi
|
|
|
|
if test -z "$CXX" ; then
|
|
CXX=g++
|
|
fi
|
|
|
|
|
|
#
|
|
# Set -Wuninitialized to debug flags for gcc 4.4 and above
|
|
# because it is allowed there without -O
|
|
#
|
|
if test `$CC -v 2>&1 | tail -1 | sed 's/ .*$//'` = 'gcc' ; then
|
|
GCCVERSION=`$CC -v 2>&1 | tail -1 | \
|
|
sed 's/^[a-zA-Z][a-zA-Z]* [a-zA-Z][a-zA-Z]* //' | sed 's/ .*$//'`
|
|
GCCV1=`echo $GCCVERSION | sed 's/\..*$//'`
|
|
GCCV2=`echo $GCCVERSION | sed 's/[0-9][0-9]*\.//'|sed 's/\..*$//'`
|
|
if test '(' "$GCCV1" -gt '4' ')' -o \
|
|
'(' '(' "$GCCV1" -eq '4' ')' -a '(' "$GCCV2" -ge '4' ')' ')'
|
|
then
|
|
debug_cflags="$debug_cflags -DFORCE_INIT_OF_VARS -Wuninitialized"
|
|
fi
|
|
if (test '(' "$GCCV1" -gt '6' ')')
|
|
then
|
|
c_warnings="$c_warnings -Wimplicit-fallthrough=2"
|
|
cxx_warnings="$cxx_warnings -Wimplicit-fallthrough=2"
|
|
fi
|
|
fi
|
|
|
|
|
|
# If ccache (a compiler cache which reduces build time)
|
|
# (http://samba.org/ccache) is installed, use it.
|
|
# We use 'grep' and hope 'grep' will work as expected
|
|
# (returns 0 if finds lines)
|
|
|
|
# As cmake doesn't like CC and CXX with a space, use symlinks from
|
|
# /usr/lib64/ccache if they exits.
|
|
|
|
if test "$USING_GCOV" != "1"
|
|
then
|
|
# Not using gcov; Safe to use ccache
|
|
CCACHE_GCOV_VERSION_ENABLED=1
|
|
fi
|
|
|
|
if ccache -V > /dev/null 2>&1 && test "$CCACHE_GCOV_VERSION_ENABLED" = "1"
|
|
then
|
|
if test -x /usr/lib64/ccache/gcc
|
|
then
|
|
CC=/usr/lib64/ccache/gcc
|
|
fi
|
|
if test -x /usr/lib64/ccache/g++
|
|
then
|
|
CXX=/usr/lib64/ccache/g++
|
|
fi
|
|
fi
|
|
|
|
# gcov
|
|
|
|
# The -fprofile-arcs and -ftest-coverage options cause GCC to instrument the
|
|
# code with profiling information used by gcov.
|
|
# The -DDISABLE_TAO_ASM is needed to avoid build failures in Yassl.
|
|
# The -DHAVE_gcov enables code to write out coverage info even when crashing.
|
|
|
|
gcov_compile_flags="-fprofile-arcs -ftest-coverage"
|
|
gcov_compile_flags="$gcov_compile_flags -DDISABLE_TAO_ASM"
|
|
gcov_compile_flags="$gcov_compile_flags -DMYSQL_SERVER_SUFFIX=-gcov -DHAVE_gcov"
|
|
|
|
#
|
|
# The following plugins doesn't work on 32 bit systems
|
|
disable_64_bit_plugins="--without-plugin-tokudb --without-plugin-rocksdb"
|
|
|
|
|
|
# GCC4 needs -fprofile-arcs -ftest-coverage on the linker command line (as well
|
|
# as on the compiler command line), and this requires setting LDFLAGS for BDB.
|
|
|
|
gcov_link_flags="-fprofile-arcs -ftest-coverage -lgcov"
|
|
|
|
gcov_configs="--with-gcov"
|
|
|
|
# gprof
|
|
|
|
gprof_compile_flags="-O2 -pg -g"
|
|
|
|
gprof_link_flags="--disable-shared $static_link"
|
|
|
|
disable_gprof_plugins="--with-zlib-dir=bundled --without-plugin-oqgraph --without-plugin-mroonga"
|
|
|
|
disable_asan_plugins="--without-plugin-rocksdb"
|