mariadb/include/myisampack.h
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

256 lines
15 KiB
C

#ifndef MYISAMPACK_INCLUDED
#define MYISAMPACK_INCLUDED
/* Copyright (c) 2000-2002, 2004 MySQL AB, 2009 Sun Microsystems, Inc.
Copyright (c) 2020, MariaDB Corporation.
Use is subject to license terms.
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 */
/*
Storing of values in high byte first order.
integer keys and file pointers are stored with high byte first to get
better compression
*/
/* these two are for uniformity */
#define mi_sint1korr(A) ((int8)(*A))
#define mi_uint1korr(A) ((uint8)(*A))
#define mi_sint2korr(A) ((int16) (((int16) (((const uchar*) (A))[1])) |\
((int16) ((uint16) ((const uchar*) (A))[0]) << 8)))
#define mi_sint3korr(A) ((int32) (((((const uchar*) (A))[0]) & 128) ? \
(((uint32) 255L << 24) | \
(((uint32) ((const uchar*) (A))[0]) << 16) |\
(((uint32) ((const uchar*) (A))[1]) << 8) | \
((uint32) ((const uchar*) (A))[2])) : \
(((uint32) ((const uchar*) (A))[0]) << 16) |\
(((uint32) ((const uchar*) (A))[1]) << 8) | \
((uint32) ((const uchar*) (A))[2])))
#define mi_sint4korr(A) ((int32) (((uint32) (((const uchar*) (A))[3])) |\
((uint32) (((const uchar*) (A))[2]) << 8) |\
((uint32) (((const uchar*) (A))[1]) << 16) |\
((uint32) (((const uchar*) (A))[0]) << 24)))
#define mi_sint8korr(A) ((longlong) mi_uint8korr(A))
#define mi_uint2korr(A) ((uint16) (((uint16) (((const uchar*) (A))[1])) |\
((uint16) (((const uchar*) (A))[0]) << 8)))
#define mi_uint3korr(A) ((uint32) (((uint32) (((const uchar*) (A))[2])) |\
(((uint32) (((const uchar*) (A))[1])) << 8) |\
(((uint32) (((const uchar*) (A))[0])) << 16)))
#define mi_uint4korr(A) ((uint32) (((uint32) (((const uchar*) (A))[3])) |\
(((uint32) (((const uchar*) (A))[2])) << 8) |\
(((uint32) (((const uchar*) (A))[1])) << 16) |\
(((uint32) (((const uchar*) (A))[0])) << 24)))
#ifndef HAVE_mi_uint5korr
#define mi_uint5korr(A) ((ulonglong)(((uint32) (((const uchar*) (A))[4])) |\
(((uint32) (((const uchar*) (A))[3])) << 8) |\
(((uint32) (((const uchar*) (A))[2])) << 16) |\
(((uint32) (((const uchar*) (A))[1])) << 24)) |\
(((ulonglong) (((const uchar*) (A))[0])) << 32))
#endif /* HAVE_mi_uint5korr */
#ifndef HAVE_mi_uint6korr
#define mi_uint6korr(A) ((ulonglong)(((uint32) (((const uchar*) (A))[5])) |\
(((uint32) (((const uchar*) (A))[4])) << 8) |\
(((uint32) (((const uchar*) (A))[3])) << 16) |\
(((uint32) (((const uchar*) (A))[2])) << 24)) |\
(((ulonglong) (((uint32) (((const uchar*) (A))[1])) |\
(((uint32) (((const uchar*) (A))[0]) << 8)))) <<\
32))
#endif /* HAVE_mi_uint6korr */
#ifndef HAVE_mi_uint7korr
#define mi_uint7korr(A) ((ulonglong)(((uint32) (((const uchar*) (A))[6])) |\
(((uint32) (((const uchar*) (A))[5])) << 8) |\
(((uint32) (((const uchar*) (A))[4])) << 16) |\
(((uint32) (((const uchar*) (A))[3])) << 24)) |\
(((ulonglong) (((uint32) (((const uchar*) (A))[2])) |\
(((uint32) (((const uchar*) (A))[1])) << 8) |\
(((uint32) (((const uchar*) (A))[0])) << 16))) <<\
32))
#endif /* HAVE_mi_uint7korr */
#ifndef HAVE_mi_uint8korr
#define mi_uint8korr(A) ((ulonglong)(((uint32) (((const uchar*) (A))[7])) |\
(((uint32) (((const uchar*) (A))[6])) << 8) |\
(((uint32) (((const uchar*) (A))[5])) << 16) |\
(((uint32) (((const uchar*) (A))[4])) << 24)) |\
(((ulonglong) (((uint32) (((const uchar*) (A))[3])) |\
(((uint32) (((const uchar*) (A))[2])) << 8) |\
(((uint32) (((const uchar*) (A))[1])) << 16) |\
(((uint32) (((const uchar*) (A))[0])) << 24))) <<\
32))
#endif /* HAVE_mi_uint8korr */
/* This one is for uniformity */
#define mi_int1store(T,A) *((uchar*)(T))= (uchar) (A)
#define mi_int2store(T,A) { uint def_temp= (uint) (A) ;\
((uchar*) (T))[1]= (uchar) (def_temp);\
((uchar*) (T))[0]= (uchar) (def_temp >> 8); }
#define mi_int3store(T,A) { /*lint -save -e734 */\
ulong def_temp= (ulong) (A);\
((uchar*) (T))[2]= (uchar) (def_temp);\
((uchar*) (T))[1]= (uchar) (def_temp >> 8);\
((uchar*) (T))[0]= (uchar) (def_temp >> 16);\
/*lint -restore */}
#define mi_int4store(T,A) { ulong def_temp= (ulong) (A);\
((uchar*) (T))[3]= (uchar) (def_temp);\
((uchar*) (T))[2]= (uchar) (def_temp >> 8);\
((uchar*) (T))[1]= (uchar) (def_temp >> 16);\
((uchar*) (T))[0]= (uchar) (def_temp >> 24); }
#define mi_int5store(T,A) { ulong def_temp= (ulong) (A),\
def_temp2= (ulong) ((A) >> 32);\
((uchar*) (T))[4]= (uchar) (def_temp);\
((uchar*) (T))[3]= (uchar) (def_temp >> 8);\
((uchar*) (T))[2]= (uchar) (def_temp >> 16);\
((uchar*) (T))[1]= (uchar) (def_temp >> 24);\
((uchar*) (T))[0]= (uchar) (def_temp2); }
#define mi_int6store(T,A) { ulong def_temp= (ulong) (A),\
def_temp2= (ulong) ((A) >> 32);\
((uchar*) (T))[5]= (uchar) (def_temp);\
((uchar*) (T))[4]= (uchar) (def_temp >> 8);\
((uchar*) (T))[3]= (uchar) (def_temp >> 16);\
((uchar*) (T))[2]= (uchar) (def_temp >> 24);\
((uchar*) (T))[1]= (uchar) (def_temp2);\
((uchar*) (T))[0]= (uchar) (def_temp2 >> 8); }
#define mi_int7store(T,A) { ulong def_temp= (ulong) (A),\
def_temp2= (ulong) ((A) >> 32);\
((uchar*) (T))[6]= (uchar) (def_temp);\
((uchar*) (T))[5]= (uchar) (def_temp >> 8);\
((uchar*) (T))[4]= (uchar) (def_temp >> 16);\
((uchar*) (T))[3]= (uchar) (def_temp >> 24);\
((uchar*) (T))[2]= (uchar) (def_temp2);\
((uchar*) (T))[1]= (uchar) (def_temp2 >> 8);\
((uchar*) (T))[0]= (uchar) (def_temp2 >> 16); }
#define mi_int8store(T,A) { ulong def_temp3= (ulong) (A),\
def_temp4= (ulong) ((A) >> 32);\
mi_int4store((uchar*) (T) + 0, def_temp4);\
mi_int4store((uchar*) (T) + 4, def_temp3); }
#ifdef WORDS_BIGENDIAN
#define mi_float4store(T,A) { ((uchar*) (T))[0]= ((uchar*) &A)[0];\
((uchar*) (T))[1]= ((uchar*) &A)[1];\
((uchar*) (T))[2]= ((uchar*) &A)[2];\
((uchar*) (T))[3]= ((uchar*) &A)[3]; }
#define mi_float4get(V,M) { float def_temp;\
((uchar*) &def_temp)[0]= ((const uchar*) (M))[0];\
((uchar*) &def_temp)[1]= ((const uchar*) (M))[1]; \
((uchar*) &def_temp)[2]= ((const uchar*) (M))[2];\
((uchar*) &def_temp)[3]= ((const uchar*) (M))[3];\
(V)= def_temp; }
#define mi_float8store(T,V) { ((uchar*) (T))[0]= ((const uchar*) &V)[0];\
((uchar*) (T))[1]= ((const uchar*) &V)[1];\
((uchar*) (T))[2]= ((const uchar*) &V)[2];\
((uchar*) (T))[3]= ((const uchar*) &V)[3];\
((uchar*) (T))[4]= ((const uchar*) &V)[4];\
((uchar*) (T))[5]= ((const uchar*) &V)[5];\
((uchar*) (T))[6]= ((const uchar*) &V)[6];\
((uchar*) (T))[7]= ((const uchar*) &V)[7]; }
#define mi_float8get(V,M) { double def_temp;\
((uchar*) &def_temp)[0]= ((const uchar*) (M))[0];\
((uchar*) &def_temp)[1]= ((const uchar*) (M))[1];\
((uchar*) &def_temp)[2]= ((const uchar*) (M))[2];\
((uchar*) &def_temp)[3]= ((const uchar*) (M))[3];\
((uchar*) &def_temp)[4]= ((const uchar*) (M))[4];\
((uchar*) &def_temp)[5]= ((const uchar*) (M))[5];\
((uchar*) &def_temp)[6]= ((const uchar*) (M))[6];\
((uchar*) &def_temp)[7]= ((const uchar*) (M))[7]; \
(V)= def_temp; }
#else
#define mi_float4store(T,A) { ((uchar*) (T))[0]= ((const uchar*) &A)[3];\
((uchar*) (T))[1]= ((const uchar*) &A)[2];\
((uchar*) (T))[2]= ((const uchar*) &A)[1];\
((uchar*) (T))[3]= ((const uchar*) &A)[0]; }
#define mi_float4get(V,M) { float def_temp;\
((uchar*) &def_temp)[0]= ((const uchar*) (M))[3];\
((uchar*) &def_temp)[1]= ((const uchar*) (M))[2];\
((uchar*) &def_temp)[2]= ((const uchar*) (M))[1];\
((uchar*) &def_temp)[3]= ((const uchar*) (M))[0];\
(V)= def_temp; }
#if defined(__FLOAT_WORD_ORDER) && (__FLOAT_WORD_ORDER == __BIG_ENDIAN)
#define mi_float8store(T,V) { ((uchar*) (T))[0]= ((const uchar*) &V)[3];\
((uchar*) (T))[1]= ((const uchar*) &V)[2];\
((uchar*) (T))[2]= ((const uchar*) &V)[1];\
((uchar*) (T))[3]= ((const uchar*) &V)[0];\
((uchar*) (T))[4]= ((const uchar*) &V)[7];\
((uchar*) (T))[5]= ((const uchar*) &V)[6];\
((uchar*) (T))[6]= ((const uchar*) &V)[5];\
((uchar*) (T))[7]= ((const uchar*) &V)[4];}
#define mi_float8get(V,M) { double def_temp;\
((uchar*) &def_temp)[0]= ((const uchar*) (M))[3];\
((uchar*) &def_temp)[1]= ((const uchar*) (M))[2];\
((uchar*) &def_temp)[2]= ((const uchar*) (M))[1];\
((uchar*) &def_temp)[3]= ((const uchar*) (M))[0];\
((uchar*) &def_temp)[4]= ((const uchar*) (M))[7];\
((uchar*) &def_temp)[5]= ((const uchar*) (M))[6];\
((uchar*) &def_temp)[6]= ((const uchar*) (M))[5];\
((uchar*) &def_temp)[7]= ((const uchar*) (M))[4];\
(V)= def_temp; }
#else
#define mi_float8store(T,V) { ((uchar*) (T))[0]= ((const uchar*) &V)[7];\
((uchar*) (T))[1]= ((const uchar*) &V)[6];\
((uchar*) (T))[2]= ((const uchar*) &V)[5];\
((uchar*) (T))[3]= ((const uchar*) &V)[4];\
((uchar*) (T))[4]= ((const uchar*) &V)[3];\
((uchar*) (T))[5]= ((const uchar*) &V)[2];\
((uchar*) (T))[6]= ((const uchar*) &V)[1];\
((uchar*) (T))[7]= ((const uchar*) &V)[0];}
#define mi_float8get(V,M) { double def_temp;\
((uchar*) &def_temp)[0]= ((const uchar*) (M))[7];\
((uchar*) &def_temp)[1]= ((const uchar*) (M))[6];\
((uchar*) &def_temp)[2]= ((const uchar*) (M))[5];\
((uchar*) &def_temp)[3]= ((const uchar*) (M))[4];\
((uchar*) &def_temp)[4]= ((const uchar*) (M))[3];\
((uchar*) &def_temp)[5]= ((const uchar*) (M))[2];\
((uchar*) &def_temp)[6]= ((const uchar*) (M))[1];\
((uchar*) &def_temp)[7]= ((const uchar*) (M))[0];\
(V)= def_temp; }
#endif /* __FLOAT_WORD_ORDER */
#endif /* WORDS_BIGENDIAN */
/* Fix to avoid warnings when sizeof(ha_rows) == sizeof(long) */
#ifdef BIG_TABLES
#define mi_rowstore(T,A) mi_int8store(T, A)
#define mi_rowkorr(T) mi_uint8korr(T)
#else
#define mi_rowstore(T,A) { mi_int4store(T, 0);\
mi_int4store(((uchar*) (T) + 4), A); }
#define mi_rowkorr(T) mi_uint4korr((const uchar*) (T) + 4)
#endif
#if SIZEOF_OFF_T > 4
#define mi_sizestore(T,A) mi_int8store(T, A)
#define mi_sizekorr(T) mi_uint8korr(T)
#else
#define mi_sizestore(T,A) { if ((A) == HA_OFFSET_ERROR)\
bfill((char*) (T), 8, 255);\
else { mi_int4store((T), 0);\
mi_int4store(((T) + 4), A); }}
#define mi_sizekorr(T) mi_uint4korr((const uchar*) (T) + 4)
#endif
#endif /* MYISAMPACK_INCLUDED */