mariadb/sql/item_buff.cc
Monty 031f11717d Fix all warnings given by UBSAN
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
2021-04-20 12:30:09 +03:00

252 lines
5.3 KiB
C++

/*
Copyright (c) 2000, 2010, Oracle and/or its affiliates.
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 */
/**
@file
@brief
Buffers to save and compare item values
*/
#include "mariadb.h"
#include "sql_priv.h"
/*
It is necessary to include set_var.h instead of item.h because there
are dependencies on include order for set_var.h and item.h. This
will be resolved later.
*/
#include "sql_class.h" // THD
#include "set_var.h" // Cached_item, Cached_item_field, ...
/**
Create right type of Cached_item for an item.
*/
Cached_item *new_Cached_item(THD *thd, Item *item, bool pass_through_ref)
{
if (pass_through_ref && item->real_item()->type() == Item::FIELD_ITEM &&
!(((Item_field *) (item->real_item()))->field->flags & BLOB_FLAG))
{
Item_field *real_item= (Item_field *) item->real_item();
Field *cached_field= real_item->field;
return new (thd->mem_root) Cached_item_field(thd, cached_field);
}
switch (item->result_type()) {
case STRING_RESULT:
return new Cached_item_str(thd, item);
case INT_RESULT:
return new Cached_item_int(item);
case REAL_RESULT:
return new Cached_item_real(item);
case DECIMAL_RESULT:
return new Cached_item_decimal(item);
case ROW_RESULT:
default:
DBUG_ASSERT(0);
return 0;
}
}
Cached_item::~Cached_item() {}
/**
Compare with old value and replace value with new value.
@return
Return true if values have changed
*/
Cached_item_str::Cached_item_str(THD *thd, Item *arg)
:Cached_item_item(arg),
value_max_length(MY_MIN(arg->max_length, thd->variables.max_sort_length)),
value(value_max_length)
{}
bool Cached_item_str::cmp(void)
{
String *res;
bool tmp;
if ((res=item->val_str(&tmp_value)))
res->length(MY_MIN(res->length(), value_max_length));
if (null_value != item->null_value)
{
if ((null_value= item->null_value))
return TRUE; // New value was null
tmp=TRUE;
}
else if (null_value)
return 0; // new and old value was null
else
tmp= sortcmp(&value,res,item->collation.collation) != 0;
if (tmp)
value.copy(*res); // Remember for next cmp
return tmp;
}
int Cached_item_str::cmp_read_only()
{
String *res= item->val_str(&tmp_value);
if (null_value)
{
if (item->null_value)
return 0;
else
return -1;
}
if (item->null_value)
return 1;
return sortcmp(&value, res, item->collation.collation);
}
Cached_item_str::~Cached_item_str()
{
item=0; // Safety
}
bool Cached_item_real::cmp(void)
{
double nr= item->val_real();
if (null_value != item->null_value || nr != value)
{
null_value= item->null_value;
value=nr;
return TRUE;
}
return FALSE;
}
int Cached_item_real::cmp_read_only()
{
double nr= item->val_real();
if (null_value)
{
if (item->null_value)
return 0;
else
return -1;
}
if (item->null_value)
return 1;
return (nr == value)? 0 : ((nr < value)? 1: -1);
}
bool Cached_item_int::cmp(void)
{
longlong nr=item->val_int();
if (null_value != item->null_value || nr != value)
{
null_value= item->null_value;
value=nr;
return TRUE;
}
return FALSE;
}
int Cached_item_int::cmp_read_only()
{
longlong nr= item->val_int();
if (null_value)
{
if (item->null_value)
return 0;
else
return -1;
}
if (item->null_value)
return 1;
return (nr == value)? 0 : ((nr < value)? 1: -1);
}
bool Cached_item_field::cmp(void)
{
bool tmp= FALSE; // Value is identical
/* Note that field can't be a blob here ! */
if (null_value != field->is_null())
{
null_value= !null_value;
tmp= TRUE; // Value has changed
}
/*
If value is not null and value changed (from null to not null or
because of value change), then copy the new value to buffer.
*/
if (! null_value && (tmp || (tmp= (field->cmp(buff) != 0))))
field->get_image(buff,length,field->charset());
return tmp;
}
int Cached_item_field::cmp_read_only()
{
if (null_value)
{
if (field->is_null())
return 0;
else
return -1;
}
if (field->is_null())
return 1;
return field->cmp(buff);
}
Cached_item_decimal::Cached_item_decimal(Item *it)
:Cached_item_item(it)
{
my_decimal_set_zero(&value);
}
bool Cached_item_decimal::cmp()
{
VDec tmp(item);
if (null_value != tmp.is_null() ||
(!tmp.is_null() && tmp.cmp(&value)))
{
null_value= tmp.is_null();
/* Save only not null values */
if (!null_value)
{
my_decimal2decimal(tmp.ptr(), &value);
return TRUE;
}
return FALSE;
}
return FALSE;
}
int Cached_item_decimal::cmp_read_only()
{
VDec tmp(item);
if (null_value)
return tmp.is_null() ? 0 : -1;
return tmp.is_null() ? 1 : value.cmp(tmp.ptr());
}