mirror of
				https://github.com/MariaDB/server.git
				synced 2025-11-03 20:36:16 +01:00 
			
		
		
		
	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
		
			
				
	
	
		
			310 lines
		
	
	
	
		
			7.4 KiB
		
	
	
	
		
			Perl
		
	
	
	
	
	
			
		
		
	
	
			310 lines
		
	
	
	
		
			7.4 KiB
		
	
	
	
		
			Perl
		
	
	
	
	
	
#!/usr/bin/env perl
 | 
						|
 | 
						|
# Copyright (c) 2009, 2012, 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 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 General Public License for more details.
 | 
						|
# 
 | 
						|
# You should have received a copy of the GNU General Public License
 | 
						|
# along with this program; if not, write to the Free Software
 | 
						|
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1335 USA
 | 
						|
 | 
						|
use strict;
 | 
						|
use Cwd 'abs_path';
 | 
						|
use File::Basename;
 | 
						|
 | 
						|
my $cmakeargs = "";
 | 
						|
 | 
						|
# Find source root directory
 | 
						|
# Assume this script is in <srcroot>/cmake
 | 
						|
my $srcdir = dirname(dirname(abs_path($0)));
 | 
						|
my $cmake_install_prefix="";
 | 
						|
my $just_print= 0;
 | 
						|
 | 
						|
# Sets installation directory,  bindir, libdir, libexecdir etc
 | 
						|
# the equivalent CMake variables are given without prefix
 | 
						|
# e.g if --prefix is /usr and --bindir is /usr/bin
 | 
						|
# then cmake variable (INSTALL_BINDIR) must be just "bin"
 | 
						|
 | 
						|
sub set_installdir 
 | 
						|
{
 | 
						|
   my($path, $varname) = @_;
 | 
						|
   my $prefix_length = length($cmake_install_prefix);
 | 
						|
   if (($prefix_length > 0) && (index($path,$cmake_install_prefix) == 0))
 | 
						|
   {
 | 
						|
      # path is under the prefix, so remove the prefix and maybe following "/"
 | 
						|
      $path = substr($path, $prefix_length);
 | 
						|
      if(length($path) > 0)
 | 
						|
      {
 | 
						|
        my $char = substr($path, 0, 1);
 | 
						|
        if($char eq "/")
 | 
						|
        {
 | 
						|
          $path= substr($path, 1);
 | 
						|
        }
 | 
						|
      }
 | 
						|
      if(length($path) > 0)
 | 
						|
      {
 | 
						|
        $cmakeargs = $cmakeargs." -D".$varname."=".$path;
 | 
						|
      }
 | 
						|
   }
 | 
						|
}
 | 
						|
 | 
						|
# CMake understands CC and CXX env.variables correctly, if they  contain 1 or 2 tokens
 | 
						|
# e.g CXX=gcc and CXX="ccache gcc" are ok. However it could have a problem if there
 | 
						|
# (recognizing gcc) with more tokens ,e.g CXX="ccache gcc --pipe".
 | 
						|
# The problem is simply fixed by splitting compiler and flags, e.g
 | 
						|
# CXX="ccache gcc --pipe" => CXX=ccache gcc CXXFLAGS=--pipe
 | 
						|
 | 
						|
sub check_compiler
 | 
						|
{
 | 
						|
  my ($varname, $flagsvarname) = @_;
 | 
						|
  my @tokens = split(/ /,$ENV{$varname});
 | 
						|
  if($#tokens >= 2)  
 | 
						|
  {
 | 
						|
    $ENV{$varname} = $tokens[0]." ".$tokens[1];
 | 
						|
    my $flags;
 | 
						|
 | 
						|
    for(my $i=2; $i<=$#tokens; $i++)
 | 
						|
    {
 | 
						|
      $flags= $flags." ".$tokens[$i];  
 | 
						|
    }
 | 
						|
    if(defined $ENV{$flagsvarname})
 | 
						|
    {
 | 
						|
      $flags = $flags." ".$ENV{$flagsvarname};
 | 
						|
    }
 | 
						|
    $ENV{$flagsvarname}=$flags;
 | 
						|
    print("$varname=$ENV{$varname}\n");
 | 
						|
    print("$flagsvarname=$ENV{$flagsvarname}\n");
 | 
						|
  }  
 | 
						|
}
 | 
						|
 | 
						|
check_compiler("CC", "CFLAGS");
 | 
						|
check_compiler("CXX", "CXXFLAGS");
 | 
						|
 | 
						|
foreach my $option (@ARGV)
 | 
						|
{
 | 
						|
  if (substr ($option, 0, 2) eq "--")
 | 
						|
  {
 | 
						|
    $option = substr($option, 2);
 | 
						|
  }
 | 
						|
  elsif (substr ($option, 0, 2) eq "-D")
 | 
						|
  {
 | 
						|
    # Must be cmake config option
 | 
						|
    $option = substr($option, 1);
 | 
						|
  }
 | 
						|
  else
 | 
						|
  {
 | 
						|
    # This must be environment variable
 | 
						|
    my @v  = split('=', $option);
 | 
						|
    my $name = shift(@v);
 | 
						|
    if(@v)
 | 
						|
    {
 | 
						|
      $ENV{$name} = join('=', @v);  
 | 
						|
    }	
 | 
						|
    next;
 | 
						|
  }
 | 
						|
  if($option =~ /srcdir/)
 | 
						|
  {
 | 
						|
    $srcdir = substr($option,7);
 | 
						|
    next;
 | 
						|
  }
 | 
						|
  if($option =~ /help/)
 | 
						|
  {
 | 
						|
    system("cmake ${srcdir} -LH");
 | 
						|
    exit(0);
 | 
						|
  }
 | 
						|
  if ($option =~ /print/)
 | 
						|
  {
 | 
						|
    $just_print=1;
 | 
						|
    next;
 | 
						|
  }
 | 
						|
  if ($option =~ /D.*=/)
 | 
						|
  {
 | 
						|
    $cmakeargs = $cmakeargs." -".$option;
 | 
						|
     next;
 | 
						|
  }
 | 
						|
  if($option =~ /with-plugins=/)
 | 
						|
  {
 | 
						|
    my @plugins= split(/,/, substr($option,13));
 | 
						|
    foreach my $p (@plugins)
 | 
						|
    {
 | 
						|
      $p =~ s/-/_/g;
 | 
						|
      $cmakeargs = $cmakeargs." -DWITH_".uc($p)."=AUTO";
 | 
						|
    }
 | 
						|
    next;
 | 
						|
  }
 | 
						|
  if($option =~ /with-extra-charsets=/)
 | 
						|
  {
 | 
						|
    my $charsets= substr($option,20);
 | 
						|
    $cmakeargs = $cmakeargs." -DWITH_EXTRA_CHARSETS=".$charsets;
 | 
						|
    next;
 | 
						|
  }
 | 
						|
  if($option =~ /without-plugin=/ || $option =~ /without-plugin-/)
 | 
						|
  {
 | 
						|
    $cmakeargs = $cmakeargs." -DPLUGIN_".uc(substr($option,15))."=NO";
 | 
						|
    next;
 | 
						|
  }
 | 
						|
  if($option =~ /with-plugin-(.*)=(.*)/)
 | 
						|
  {
 | 
						|
    $cmakeargs = $cmakeargs." -DPLUGIN_".uc($1)."=".uc($2);
 | 
						|
    next;
 | 
						|
  }
 | 
						|
  if($option =~ /without-wsrep/)
 | 
						|
  {
 | 
						|
    $cmakeargs = $cmakeargs." -DWITH_WSREP=OFF";
 | 
						|
    next;
 | 
						|
  }
 | 
						|
  if($option =~ /with-zlib-dir=bundled/)
 | 
						|
  {
 | 
						|
    $cmakeargs = $cmakeargs." -DWITH_ZLIB=bundled";
 | 
						|
    next;
 | 
						|
  }
 | 
						|
  if($option =~ /with-zlib-dir=/)
 | 
						|
  {
 | 
						|
    $cmakeargs = $cmakeargs." -DWITH_ZLIB=system";
 | 
						|
    next;
 | 
						|
  }
 | 
						|
  if($option =~ /with-libevent=/)
 | 
						|
  {
 | 
						|
    $cmakeargs = $cmakeargs." -DWITH_LIBEVENT=system";
 | 
						|
    next;
 | 
						|
  }
 | 
						|
  if($option =~ /with-libevent/)
 | 
						|
  {
 | 
						|
    $cmakeargs = $cmakeargs." -DWITH_LIBEVENT=bundled";
 | 
						|
    next;
 | 
						|
  }
 | 
						|
  if($option =~ /with-ssl=yes/)
 | 
						|
  {
 | 
						|
    $cmakeargs = $cmakeargs." -DWITH_SSL=yes";
 | 
						|
    next;
 | 
						|
  }
 | 
						|
  if($option =~ /with-ssl=system/)
 | 
						|
  {
 | 
						|
    $cmakeargs = $cmakeargs." -DWITH_SSL=system";
 | 
						|
    next;
 | 
						|
  }
 | 
						|
  if($option =~ /with-ssl$/)
 | 
						|
  {
 | 
						|
    $cmakeargs = $cmakeargs." -DWITH_SSL=bundled";
 | 
						|
    next;
 | 
						|
  }
 | 
						|
  if($option =~ /with-debug/)
 | 
						|
  {
 | 
						|
    $cmakeargs = $cmakeargs." -DCMAKE_BUILD_TYPE=Debug -DSECURITY_HARDENED=OFF";
 | 
						|
    next;
 | 
						|
  }
 | 
						|
  if($option =~ /with-(.*)=(.*)/)
 | 
						|
  {
 | 
						|
    $cmakeargs = $cmakeargs. " -DWITH_" . uc($1) . "=" . uc($2);
 | 
						|
    next;
 | 
						|
  }
 | 
						|
  if($option =~ /without-(.*)=(.*)/)
 | 
						|
  {
 | 
						|
    $cmakeargs = $cmakeargs. " -DWITHOUT_" . uc($1) . "=" . uc($2);
 | 
						|
    next;
 | 
						|
  }
 | 
						|
  if($option =~ /prefix=/)
 | 
						|
  {
 | 
						|
    $cmake_install_prefix= substr($option, 7);
 | 
						|
    $cmakeargs = $cmakeargs." -DCMAKE_INSTALL_PREFIX=".$cmake_install_prefix;
 | 
						|
    next;
 | 
						|
  }
 | 
						|
  if($option =~/bindir=/)
 | 
						|
  {
 | 
						|
    set_installdir(substr($option,7), "INSTALL_BINDIR");
 | 
						|
    next;
 | 
						|
  }
 | 
						|
  if($option =~/libdir=/)
 | 
						|
  {
 | 
						|
    set_installdir(substr($option,7), "INSTALL_LIBDIR");
 | 
						|
    next;
 | 
						|
  }
 | 
						|
  if($option =~/libexecdir=/)
 | 
						|
  {
 | 
						|
    set_installdir(substr($option,11), "INSTALL_SBINDIR");
 | 
						|
    next;
 | 
						|
  }
 | 
						|
  if($option =~/includedir=/)
 | 
						|
  {
 | 
						|
    set_installdir(substr($option,11), "INSTALL_INCLUDEDIR");
 | 
						|
    next;
 | 
						|
  }
 | 
						|
  if ($option =~ /extra-charsets=all/)
 | 
						|
  {
 | 
						|
    $cmakeargs = $cmakeargs." -DWITH_CHARSETS=all"; 
 | 
						|
    next;
 | 
						|
  }
 | 
						|
  if ($option =~ /extra-charsets=complex/)
 | 
						|
  {
 | 
						|
    $cmakeargs = $cmakeargs." -DWITH_CHARSETS=complex"; 
 | 
						|
    next;
 | 
						|
  }
 | 
						|
  if ($option =~ /localstatedir=/)
 | 
						|
  {
 | 
						|
    $cmakeargs = $cmakeargs." -DMYSQL_DATADIR=".substr($option,14); 
 | 
						|
    next;
 | 
						|
  }
 | 
						|
  if ($option =~ /mysql-maintainer-mode/)
 | 
						|
  {
 | 
						|
    $cmakeargs = $cmakeargs." -DMYSQL_MAINTAINER_MODE=" .
 | 
						|
                 ($option =~ /enable/ ? "1" : "0");
 | 
						|
    next;
 | 
						|
  }
 | 
						|
  if ($option =~ /with-comment=/)
 | 
						|
  {
 | 
						|
    $cmakeargs = $cmakeargs." \"-DWITH_COMMENT=".substr($option,13)."\""; 
 | 
						|
    next;
 | 
						|
  }
 | 
						|
  if ($option =~ /with-gcov/)
 | 
						|
  {
 | 
						|
      $cmakeargs = $cmakeargs." -DENABLE_GCOV=ON"; 
 | 
						|
      next;
 | 
						|
  }
 | 
						|
  if ($option =~ /with-max-indexes=/)
 | 
						|
  {
 | 
						|
    $cmakeargs = $cmakeargs." -DMAX_INDEXES=".substr($option, 17); 
 | 
						|
    next;
 | 
						|
  }
 | 
						|
  if ($option =~ /verbose/)
 | 
						|
  {
 | 
						|
      $cmakeargs = $cmakeargs." -DCMAKE_VERBOSE_MAKEFILE=1";
 | 
						|
      next;
 | 
						|
  }
 | 
						|
  if ($option =~ /with-client-ldflags/)
 | 
						|
  {
 | 
						|
      print("configure.pl : ignoring $option\n");
 | 
						|
      next;
 | 
						|
  }
 | 
						|
  if ($option =~ /with-mysqld-ldflags=/)
 | 
						|
  {
 | 
						|
      print("configure.pl : ignoring $option\n");
 | 
						|
      next;
 | 
						|
  }
 | 
						|
  if ($option =~ /with-client-ldflags/)
 | 
						|
  {
 | 
						|
      print("configure.pl : ignoring $option\n");
 | 
						|
      next;
 | 
						|
  }
 | 
						|
  if ($option =~ /with-mysqld-ldflags=/)
 | 
						|
  {
 | 
						|
      print("configure.pl : ignoring $option\n");
 | 
						|
      next;
 | 
						|
  }
 | 
						|
 | 
						|
  $option = uc($option);
 | 
						|
  $option =~ s/-/_/g;
 | 
						|
  $cmakeargs = $cmakeargs." -D".$option."=1";
 | 
						|
}
 | 
						|
 | 
						|
print("configure.pl : calling cmake $srcdir $cmakeargs\n");
 | 
						|
exit(0) if ($just_print);
 | 
						|
unlink("CMakeCache.txt");
 | 
						|
my $rc = system("cmake $srcdir $cmakeargs");
 | 
						|
exit($rc);
 |