Blame src/gl/intprops.h

Packit Service 4684c1
/* intprops.h -- properties of integer types
Packit Service 4684c1
Packit Service 4684c1
   Copyright (C) 2001-2020 Free Software Foundation, Inc.
Packit Service 4684c1
Packit Service 4684c1
   This program is free software: you can redistribute it and/or modify it
Packit Service 4684c1
   under the terms of the GNU General Public License as published
Packit Service 4684c1
   by the Free Software Foundation; either version 3 of the License, or
Packit Service 4684c1
   (at your option) any later version.
Packit Service 4684c1
Packit Service 4684c1
   This program is distributed in the hope that it will be useful,
Packit Service 4684c1
   but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit Service 4684c1
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Packit Service 4684c1
   GNU General Public License for more details.
Packit Service 4684c1
Packit Service 4684c1
   You should have received a copy of the GNU General Public License
Packit Service 4684c1
   along with this program.  If not, see <https://www.gnu.org/licenses/>.  */
Packit Service 4684c1
Packit Service 4684c1
/* Written by Paul Eggert.  */
Packit Service 4684c1
Packit Service 4684c1
#ifndef _GL_INTPROPS_H
Packit Service 4684c1
#define _GL_INTPROPS_H
Packit Service 4684c1
Packit Service 4684c1
#include <limits.h>
Packit Service 4684c1
Packit Service 4684c1
/* Return a value with the common real type of E and V and the value of V.
Packit Service 4684c1
   Do not evaluate E.  */
Packit Service 4684c1
#define _GL_INT_CONVERT(e, v) ((1 ? 0 : (e)) + (v))
Packit Service 4684c1
Packit Service 4684c1
/* Act like _GL_INT_CONVERT (E, -V) but work around a bug in IRIX 6.5 cc; see
Packit Service 4684c1
   <https://lists.gnu.org/r/bug-gnulib/2011-05/msg00406.html>.  */
Packit Service 4684c1
#define _GL_INT_NEGATE_CONVERT(e, v) ((1 ? 0 : (e)) - (v))
Packit Service 4684c1
Packit Service 4684c1
/* The extra casts in the following macros work around compiler bugs,
Packit Service 4684c1
   e.g., in Cray C 5.0.3.0.  */
Packit Service 4684c1
Packit Service 4684c1
/* True if the arithmetic type T is an integer type.  bool counts as
Packit Service 4684c1
   an integer.  */
Packit Service 4684c1
#define TYPE_IS_INTEGER(t) ((t) 1.5 == 1)
Packit Service 4684c1
Packit Service 4684c1
/* True if the real type T is signed.  */
Packit Service 4684c1
#define TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
Packit Service 4684c1
Packit Service 4684c1
/* Return 1 if the real expression E, after promotion, has a
Packit Service 4684c1
   signed or floating type.  Do not evaluate E.  */
Packit Service 4684c1
#define EXPR_SIGNED(e) (_GL_INT_NEGATE_CONVERT (e, 1) < 0)
Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
/* Minimum and maximum values for integer types and expressions.  */
Packit Service 4684c1
Packit Service 4684c1
/* The width in bits of the integer type or expression T.
Packit Service 4684c1
   Do not evaluate T.
Packit Service 4684c1
   Padding bits are not supported; this is checked at compile-time below.  */
Packit Service 4684c1
#define TYPE_WIDTH(t) (sizeof (t) * CHAR_BIT)
Packit Service 4684c1
Packit Service 4684c1
/* The maximum and minimum values for the integer type T.  */
Packit Service 4684c1
#define TYPE_MINIMUM(t) ((t) ~ TYPE_MAXIMUM (t))
Packit Service 4684c1
#define TYPE_MAXIMUM(t)                                                 \
Packit Service 4684c1
  ((t) (! TYPE_SIGNED (t)                                               \
Packit Service 4684c1
        ? (t) -1                                                        \
Packit Service 4684c1
        : ((((t) 1 << (TYPE_WIDTH (t) - 2)) - 1) * 2 + 1)))
Packit Service 4684c1
Packit Service 4684c1
/* The maximum and minimum values for the type of the expression E,
Packit Service 4684c1
   after integer promotion.  E is not evaluated.  */
Packit Service 4684c1
#define _GL_INT_MINIMUM(e)                                              \
Packit Service 4684c1
  (EXPR_SIGNED (e)                                                      \
Packit Service 4684c1
   ? ~ _GL_SIGNED_INT_MAXIMUM (e)                                       \
Packit Service 4684c1
   : _GL_INT_CONVERT (e, 0))
Packit Service 4684c1
#define _GL_INT_MAXIMUM(e)                                              \
Packit Service 4684c1
  (EXPR_SIGNED (e)                                                      \
Packit Service 4684c1
   ? _GL_SIGNED_INT_MAXIMUM (e)                                         \
Packit Service 4684c1
   : _GL_INT_NEGATE_CONVERT (e, 1))
Packit Service 4684c1
#define _GL_SIGNED_INT_MAXIMUM(e)                                       \
Packit Service 4684c1
  (((_GL_INT_CONVERT (e, 1) << (TYPE_WIDTH ((e) + 0) - 2)) - 1) * 2 + 1)
Packit Service 4684c1
Packit Service 4684c1
/* Work around OpenVMS incompatibility with C99.  */
Packit Service 4684c1
#if !defined LLONG_MAX && defined __INT64_MAX
Packit Service 4684c1
# define LLONG_MAX __INT64_MAX
Packit Service 4684c1
# define LLONG_MIN __INT64_MIN
Packit Service 4684c1
#endif
Packit Service 4684c1
Packit Service 4684c1
/* This include file assumes that signed types are two's complement without
Packit Service 4684c1
   padding bits; the above macros have undefined behavior otherwise.
Packit Service 4684c1
   If this is a problem for you, please let us know how to fix it for your host.
Packit Service 4684c1
   This assumption is tested by the intprops-tests module.  */
Packit Service 4684c1
Packit Service 4684c1
/* Does the __typeof__ keyword work?  This could be done by
Packit Service 4684c1
   'configure', but for now it's easier to do it by hand.  */
Packit Service 4684c1
#if (2 <= __GNUC__ \
Packit Service 4684c1
     || (1210 <= __IBMC__ && defined __IBM__TYPEOF__) \
Packit Service 4684c1
     || (0x5110 <= __SUNPRO_C && !__STDC__))
Packit Service 4684c1
# define _GL_HAVE___TYPEOF__ 1
Packit Service 4684c1
#else
Packit Service 4684c1
# define _GL_HAVE___TYPEOF__ 0
Packit Service 4684c1
#endif
Packit Service 4684c1
Packit Service 4684c1
/* Return 1 if the integer type or expression T might be signed.  Return 0
Packit Service 4684c1
   if it is definitely unsigned.  This macro does not evaluate its argument,
Packit Service 4684c1
   and expands to an integer constant expression.  */
Packit Service 4684c1
#if _GL_HAVE___TYPEOF__
Packit Service 4684c1
# define _GL_SIGNED_TYPE_OR_EXPR(t) TYPE_SIGNED (__typeof__ (t))
Packit Service 4684c1
#else
Packit Service 4684c1
# define _GL_SIGNED_TYPE_OR_EXPR(t) 1
Packit Service 4684c1
#endif
Packit Service 4684c1
Packit Service 4684c1
/* Bound on length of the string representing an unsigned integer
Packit Service 4684c1
   value representable in B bits.  log10 (2.0) < 146/485.  The
Packit Service 4684c1
   smallest value of B where this bound is not tight is 2621.  */
Packit Service 4684c1
#define INT_BITS_STRLEN_BOUND(b) (((b) * 146 + 484) / 485)
Packit Service 4684c1
Packit Service 4684c1
/* Bound on length of the string representing an integer type or expression T.
Packit Service 4684c1
   Subtract 1 for the sign bit if T is signed, and then add 1 more for
Packit Service 4684c1
   a minus sign if needed.
Packit Service 4684c1
Packit Service 4684c1
   Because _GL_SIGNED_TYPE_OR_EXPR sometimes returns 1 when its argument is
Packit Service 4684c1
   unsigned, this macro may overestimate the true bound by one byte when
Packit Service 4684c1
   applied to unsigned types of size 2, 4, 16, ... bytes.  */
Packit Service 4684c1
#define INT_STRLEN_BOUND(t)                                     \
Packit Service 4684c1
  (INT_BITS_STRLEN_BOUND (TYPE_WIDTH (t) - _GL_SIGNED_TYPE_OR_EXPR (t)) \
Packit Service 4684c1
   + _GL_SIGNED_TYPE_OR_EXPR (t))
Packit Service 4684c1
Packit Service 4684c1
/* Bound on buffer size needed to represent an integer type or expression T,
Packit Service 4684c1
   including the terminating null.  */
Packit Service 4684c1
#define INT_BUFSIZE_BOUND(t) (INT_STRLEN_BOUND (t) + 1)
Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
/* Range overflow checks.
Packit Service 4684c1
Packit Service 4684c1
   The INT_<op>_RANGE_OVERFLOW macros return 1 if the corresponding C
Packit Service 4684c1
   operators might not yield numerically correct answers due to
Packit Service 4684c1
   arithmetic overflow.  They do not rely on undefined or
Packit Service 4684c1
   implementation-defined behavior.  Their implementations are simple
Packit Service 4684c1
   and straightforward, but they are a bit harder to use than the
Packit Service 4684c1
   INT_<op>_OVERFLOW macros described below.
Packit Service 4684c1
Packit Service 4684c1
   Example usage:
Packit Service 4684c1
Packit Service 4684c1
     long int i = ...;
Packit Service 4684c1
     long int j = ...;
Packit Service 4684c1
     if (INT_MULTIPLY_RANGE_OVERFLOW (i, j, LONG_MIN, LONG_MAX))
Packit Service 4684c1
       printf ("multiply would overflow");
Packit Service 4684c1
     else
Packit Service 4684c1
       printf ("product is %ld", i * j);
Packit Service 4684c1
Packit Service 4684c1
   Restrictions on *_RANGE_OVERFLOW macros:
Packit Service 4684c1
Packit Service 4684c1
   These macros do not check for all possible numerical problems or
Packit Service 4684c1
   undefined or unspecified behavior: they do not check for division
Packit Service 4684c1
   by zero, for bad shift counts, or for shifting negative numbers.
Packit Service 4684c1
Packit Service 4684c1
   These macros may evaluate their arguments zero or multiple times,
Packit Service 4684c1
   so the arguments should not have side effects.  The arithmetic
Packit Service 4684c1
   arguments (including the MIN and MAX arguments) must be of the same
Packit Service 4684c1
   integer type after the usual arithmetic conversions, and the type
Packit Service 4684c1
   must have minimum value MIN and maximum MAX.  Unsigned types should
Packit Service 4684c1
   use a zero MIN of the proper type.
Packit Service 4684c1
Packit Service 4684c1
   These macros are tuned for constant MIN and MAX.  For commutative
Packit Service 4684c1
   operations such as A + B, they are also tuned for constant B.  */
Packit Service 4684c1
Packit Service 4684c1
/* Return 1 if A + B would overflow in [MIN,MAX] arithmetic.
Packit Service 4684c1
   See above for restrictions.  */
Packit Service 4684c1
#define INT_ADD_RANGE_OVERFLOW(a, b, min, max)          \
Packit Service 4684c1
  ((b) < 0                                              \
Packit Service 4684c1
   ? (a) < (min) - (b)                                  \
Packit Service 4684c1
   : (max) - (b) < (a))
Packit Service 4684c1
Packit Service 4684c1
/* Return 1 if A - B would overflow in [MIN,MAX] arithmetic.
Packit Service 4684c1
   See above for restrictions.  */
Packit Service 4684c1
#define INT_SUBTRACT_RANGE_OVERFLOW(a, b, min, max)     \
Packit Service 4684c1
  ((b) < 0                                              \
Packit Service 4684c1
   ? (max) + (b) < (a)                                  \
Packit Service 4684c1
   : (a) < (min) + (b))
Packit Service 4684c1
Packit Service 4684c1
/* Return 1 if - A would overflow in [MIN,MAX] arithmetic.
Packit Service 4684c1
   See above for restrictions.  */
Packit Service 4684c1
#define INT_NEGATE_RANGE_OVERFLOW(a, min, max)          \
Packit Service 4684c1
  ((min) < 0                                            \
Packit Service 4684c1
   ? (a) < - (max)                                      \
Packit Service 4684c1
   : 0 < (a))
Packit Service 4684c1
Packit Service 4684c1
/* Return 1 if A * B would overflow in [MIN,MAX] arithmetic.
Packit Service 4684c1
   See above for restrictions.  Avoid && and || as they tickle
Packit Service 4684c1
   bugs in Sun C 5.11 2010/08/13 and other compilers; see
Packit Service 4684c1
   <https://lists.gnu.org/r/bug-gnulib/2011-05/msg00401.html>.  */
Packit Service 4684c1
#define INT_MULTIPLY_RANGE_OVERFLOW(a, b, min, max)     \
Packit Service 4684c1
  ((b) < 0                                              \
Packit Service 4684c1
   ? ((a) < 0                                           \
Packit Service 4684c1
      ? (a) < (max) / (b)                               \
Packit Service 4684c1
      : (b) == -1                                       \
Packit Service 4684c1
      ? 0                                               \
Packit Service 4684c1
      : (min) / (b) < (a))                              \
Packit Service 4684c1
   : (b) == 0                                           \
Packit Service 4684c1
   ? 0                                                  \
Packit Service 4684c1
   : ((a) < 0                                           \
Packit Service 4684c1
      ? (a) < (min) / (b)                               \
Packit Service 4684c1
      : (max) / (b) < (a)))
Packit Service 4684c1
Packit Service 4684c1
/* Return 1 if A / B would overflow in [MIN,MAX] arithmetic.
Packit Service 4684c1
   See above for restrictions.  Do not check for division by zero.  */
Packit Service 4684c1
#define INT_DIVIDE_RANGE_OVERFLOW(a, b, min, max)       \
Packit Service 4684c1
  ((min) < 0 && (b) == -1 && (a) < - (max))
Packit Service 4684c1
Packit Service 4684c1
/* Return 1 if A % B would overflow in [MIN,MAX] arithmetic.
Packit Service 4684c1
   See above for restrictions.  Do not check for division by zero.
Packit Service 4684c1
   Mathematically, % should never overflow, but on x86-like hosts
Packit Service 4684c1
   INT_MIN % -1 traps, and the C standard permits this, so treat this
Packit Service 4684c1
   as an overflow too.  */
Packit Service 4684c1
#define INT_REMAINDER_RANGE_OVERFLOW(a, b, min, max)    \
Packit Service 4684c1
  INT_DIVIDE_RANGE_OVERFLOW (a, b, min, max)
Packit Service 4684c1
Packit Service 4684c1
/* Return 1 if A << B would overflow in [MIN,MAX] arithmetic.
Packit Service 4684c1
   See above for restrictions.  Here, MIN and MAX are for A only, and B need
Packit Service 4684c1
   not be of the same type as the other arguments.  The C standard says that
Packit Service 4684c1
   behavior is undefined for shifts unless 0 <= B < wordwidth, and that when
Packit Service 4684c1
   A is negative then A << B has undefined behavior and A >> B has
Packit Service 4684c1
   implementation-defined behavior, but do not check these other
Packit Service 4684c1
   restrictions.  */
Packit Service 4684c1
#define INT_LEFT_SHIFT_RANGE_OVERFLOW(a, b, min, max)   \
Packit Service 4684c1
  ((a) < 0                                              \
Packit Service 4684c1
   ? (a) < (min) >> (b)                                 \
Packit Service 4684c1
   : (max) >> (b) < (a))
Packit Service 4684c1
Packit Service 4684c1
/* True if __builtin_add_overflow (A, B, P) and __builtin_sub_overflow
Packit Service 4684c1
   (A, B, P) work when P is non-null.  */
Packit Service 4684c1
#if 5 <= __GNUC__ && !defined __ICC
Packit Service 4684c1
# define _GL_HAS_BUILTIN_ADD_OVERFLOW 1
Packit Service 4684c1
#elif defined __has_builtin
Packit Service 4684c1
# define _GL_HAS_BUILTIN_ADD_OVERFLOW __has_builtin (__builtin_add_overflow)
Packit Service 4684c1
#else
Packit Service 4684c1
# define _GL_HAS_BUILTIN_ADD_OVERFLOW 0
Packit Service 4684c1
#endif
Packit Service 4684c1
Packit Service 4684c1
/* True if __builtin_mul_overflow (A, B, P) works when P is non-null.  */
Packit Service 4684c1
#ifdef __clang__
Packit Service 4684c1
/* Work around Clang bug <https://bugs.llvm.org/show_bug.cgi?id=16404>.  */
Packit Service 4684c1
# define _GL_HAS_BUILTIN_MUL_OVERFLOW 0
Packit Service 4684c1
#else
Packit Service 4684c1
# define _GL_HAS_BUILTIN_MUL_OVERFLOW _GL_HAS_BUILTIN_ADD_OVERFLOW
Packit Service 4684c1
#endif
Packit Service 4684c1
Packit Service 4684c1
/* True if __builtin_add_overflow_p (A, B, C) works, and similarly for
Packit Service 4684c1
   __builtin_mul_overflow_p and __builtin_mul_overflow_p.  */
Packit Service 4684c1
#define _GL_HAS_BUILTIN_OVERFLOW_P (7 <= __GNUC__)
Packit Service 4684c1
Packit Service 4684c1
/* The _GL*_OVERFLOW macros have the same restrictions as the
Packit Service 4684c1
   *_RANGE_OVERFLOW macros, except that they do not assume that operands
Packit Service 4684c1
   (e.g., A and B) have the same type as MIN and MAX.  Instead, they assume
Packit Service 4684c1
   that the result (e.g., A + B) has that type.  */
Packit Service 4684c1
#if _GL_HAS_BUILTIN_OVERFLOW_P
Packit Service 4684c1
# define _GL_ADD_OVERFLOW(a, b, min, max)                               \
Packit Service 4684c1
   __builtin_add_overflow_p (a, b, (__typeof__ ((a) + (b))) 0)
Packit Service 4684c1
# define _GL_SUBTRACT_OVERFLOW(a, b, min, max)                          \
Packit Service 4684c1
   __builtin_sub_overflow_p (a, b, (__typeof__ ((a) - (b))) 0)
Packit Service 4684c1
# define _GL_MULTIPLY_OVERFLOW(a, b, min, max)                          \
Packit Service 4684c1
   __builtin_mul_overflow_p (a, b, (__typeof__ ((a) * (b))) 0)
Packit Service 4684c1
#else
Packit Service 4684c1
# define _GL_ADD_OVERFLOW(a, b, min, max)                                \
Packit Service 4684c1
   ((min) < 0 ? INT_ADD_RANGE_OVERFLOW (a, b, min, max)                  \
Packit Service 4684c1
    : (a) < 0 ? (b) <= (a) + (b)                                         \
Packit Service 4684c1
    : (b) < 0 ? (a) <= (a) + (b)                                         \
Packit Service 4684c1
    : (a) + (b) < (b))
Packit Service 4684c1
# define _GL_SUBTRACT_OVERFLOW(a, b, min, max)                           \
Packit Service 4684c1
   ((min) < 0 ? INT_SUBTRACT_RANGE_OVERFLOW (a, b, min, max)             \
Packit Service 4684c1
    : (a) < 0 ? 1                                                        \
Packit Service 4684c1
    : (b) < 0 ? (a) - (b) <= (a)                                         \
Packit Service 4684c1
    : (a) < (b))
Packit Service 4684c1
# define _GL_MULTIPLY_OVERFLOW(a, b, min, max)                           \
Packit Service 4684c1
   (((min) == 0 && (((a) < 0 && 0 < (b)) || ((b) < 0 && 0 < (a))))       \
Packit Service 4684c1
    || INT_MULTIPLY_RANGE_OVERFLOW (a, b, min, max))
Packit Service 4684c1
#endif
Packit Service 4684c1
#define _GL_DIVIDE_OVERFLOW(a, b, min, max)                             \
Packit Service 4684c1
  ((min) < 0 ? (b) == _GL_INT_NEGATE_CONVERT (min, 1) && (a) < - (max)  \
Packit Service 4684c1
   : (a) < 0 ? (b) <= (a) + (b) - 1                                     \
Packit Service 4684c1
   : (b) < 0 && (a) + (b) <= (a))
Packit Service 4684c1
#define _GL_REMAINDER_OVERFLOW(a, b, min, max)                          \
Packit Service 4684c1
  ((min) < 0 ? (b) == _GL_INT_NEGATE_CONVERT (min, 1) && (a) < - (max)  \
Packit Service 4684c1
   : (a) < 0 ? (a) % (b) != ((max) - (b) + 1) % (b)                     \
Packit Service 4684c1
   : (b) < 0 && ! _GL_UNSIGNED_NEG_MULTIPLE (a, b, max))
Packit Service 4684c1
Packit Service 4684c1
/* Return a nonzero value if A is a mathematical multiple of B, where
Packit Service 4684c1
   A is unsigned, B is negative, and MAX is the maximum value of A's
Packit Service 4684c1
   type.  A's type must be the same as (A % B)'s type.  Normally (A %
Packit Service 4684c1
   -B == 0) suffices, but things get tricky if -B would overflow.  */
Packit Service 4684c1
#define _GL_UNSIGNED_NEG_MULTIPLE(a, b, max)                            \
Packit Service 4684c1
  (((b) < -_GL_SIGNED_INT_MAXIMUM (b)                                   \
Packit Service 4684c1
    ? (_GL_SIGNED_INT_MAXIMUM (b) == (max)                              \
Packit Service 4684c1
       ? (a)                                                            \
Packit Service 4684c1
       : (a) % (_GL_INT_CONVERT (a, _GL_SIGNED_INT_MAXIMUM (b)) + 1))   \
Packit Service 4684c1
    : (a) % - (b))                                                      \
Packit Service 4684c1
   == 0)
Packit Service 4684c1
Packit Service 4684c1
/* Check for integer overflow, and report low order bits of answer.
Packit Service 4684c1
Packit Service 4684c1
   The INT_<op>_OVERFLOW macros return 1 if the corresponding C operators
Packit Service 4684c1
   might not yield numerically correct answers due to arithmetic overflow.
Packit Service 4684c1
   The INT_<op>_WRAPV macros compute the low-order bits of the sum,
Packit Service 4684c1
   difference, and product of two C integers, and return 1 if these
Packit Service 4684c1
   low-order bits are not numerically correct.
Packit Service 4684c1
   These macros work correctly on all known practical hosts, and do not rely
Packit Service 4684c1
   on undefined behavior due to signed arithmetic overflow.
Packit Service 4684c1
Packit Service 4684c1
   Example usage, assuming A and B are long int:
Packit Service 4684c1
Packit Service 4684c1
     if (INT_MULTIPLY_OVERFLOW (a, b))
Packit Service 4684c1
       printf ("result would overflow\n");
Packit Service 4684c1
     else
Packit Service 4684c1
       printf ("result is %ld (no overflow)\n", a * b);
Packit Service 4684c1
Packit Service 4684c1
   Example usage with WRAPV flavor:
Packit Service 4684c1
Packit Service 4684c1
     long int result;
Packit Service 4684c1
     bool overflow = INT_MULTIPLY_WRAPV (a, b, &result);
Packit Service 4684c1
     printf ("result is %ld (%s)\n", result,
Packit Service 4684c1
             overflow ? "after overflow" : "no overflow");
Packit Service 4684c1
Packit Service 4684c1
   Restrictions on these macros:
Packit Service 4684c1
Packit Service 4684c1
   These macros do not check for all possible numerical problems or
Packit Service 4684c1
   undefined or unspecified behavior: they do not check for division
Packit Service 4684c1
   by zero, for bad shift counts, or for shifting negative numbers.
Packit Service 4684c1
Packit Service 4684c1
   These macros may evaluate their arguments zero or multiple times, so the
Packit Service 4684c1
   arguments should not have side effects.
Packit Service 4684c1
Packit Service 4684c1
   The WRAPV macros are not constant expressions.  They support only
Packit Service 4684c1
   +, binary -, and *.  Because the WRAPV macros convert the result,
Packit Service 4684c1
   they report overflow in different circumstances than the OVERFLOW
Packit Service 4684c1
   macros do.
Packit Service 4684c1
Packit Service 4684c1
   These macros are tuned for their last input argument being a constant.
Packit Service 4684c1
Packit Service 4684c1
   Return 1 if the integer expressions A * B, A - B, -A, A * B, A / B,
Packit Service 4684c1
   A % B, and A << B would overflow, respectively.  */
Packit Service 4684c1
Packit Service 4684c1
#define INT_ADD_OVERFLOW(a, b) \
Packit Service 4684c1
  _GL_BINARY_OP_OVERFLOW (a, b, _GL_ADD_OVERFLOW)
Packit Service 4684c1
#define INT_SUBTRACT_OVERFLOW(a, b) \
Packit Service 4684c1
  _GL_BINARY_OP_OVERFLOW (a, b, _GL_SUBTRACT_OVERFLOW)
Packit Service 4684c1
#if _GL_HAS_BUILTIN_OVERFLOW_P
Packit Service 4684c1
# define INT_NEGATE_OVERFLOW(a) INT_SUBTRACT_OVERFLOW (0, a)
Packit Service 4684c1
#else
Packit Service 4684c1
# define INT_NEGATE_OVERFLOW(a) \
Packit Service 4684c1
   INT_NEGATE_RANGE_OVERFLOW (a, _GL_INT_MINIMUM (a), _GL_INT_MAXIMUM (a))
Packit Service 4684c1
#endif
Packit Service 4684c1
#define INT_MULTIPLY_OVERFLOW(a, b) \
Packit Service 4684c1
  _GL_BINARY_OP_OVERFLOW (a, b, _GL_MULTIPLY_OVERFLOW)
Packit Service 4684c1
#define INT_DIVIDE_OVERFLOW(a, b) \
Packit Service 4684c1
  _GL_BINARY_OP_OVERFLOW (a, b, _GL_DIVIDE_OVERFLOW)
Packit Service 4684c1
#define INT_REMAINDER_OVERFLOW(a, b) \
Packit Service 4684c1
  _GL_BINARY_OP_OVERFLOW (a, b, _GL_REMAINDER_OVERFLOW)
Packit Service 4684c1
#define INT_LEFT_SHIFT_OVERFLOW(a, b) \
Packit Service 4684c1
  INT_LEFT_SHIFT_RANGE_OVERFLOW (a, b, \
Packit Service 4684c1
                                 _GL_INT_MINIMUM (a), _GL_INT_MAXIMUM (a))
Packit Service 4684c1
Packit Service 4684c1
/* Return 1 if the expression A <op> B would overflow,
Packit Service 4684c1
   where OP_RESULT_OVERFLOW (A, B, MIN, MAX) does the actual test,
Packit Service 4684c1
   assuming MIN and MAX are the minimum and maximum for the result type.
Packit Service 4684c1
   Arguments should be free of side effects.  */
Packit Service 4684c1
#define _GL_BINARY_OP_OVERFLOW(a, b, op_result_overflow)        \
Packit Service 4684c1
  op_result_overflow (a, b,                                     \
Packit Service 4684c1
                      _GL_INT_MINIMUM (_GL_INT_CONVERT (a, b)), \
Packit Service 4684c1
                      _GL_INT_MAXIMUM (_GL_INT_CONVERT (a, b)))
Packit Service 4684c1
Packit Service 4684c1
/* Store the low-order bits of A + B, A - B, A * B, respectively, into *R.
Packit Service 4684c1
   Return 1 if the result overflows.  See above for restrictions.  */
Packit Service 4684c1
#if _GL_HAS_BUILTIN_ADD_OVERFLOW
Packit Service 4684c1
# define INT_ADD_WRAPV(a, b, r) __builtin_add_overflow (a, b, r)
Packit Service 4684c1
# define INT_SUBTRACT_WRAPV(a, b, r) __builtin_sub_overflow (a, b, r)
Packit Service 4684c1
#else
Packit Service 4684c1
# define INT_ADD_WRAPV(a, b, r) \
Packit Service 4684c1
   _GL_INT_OP_WRAPV (a, b, r, +, _GL_INT_ADD_RANGE_OVERFLOW)
Packit Service 4684c1
# define INT_SUBTRACT_WRAPV(a, b, r) \
Packit Service 4684c1
   _GL_INT_OP_WRAPV (a, b, r, -, _GL_INT_SUBTRACT_RANGE_OVERFLOW)
Packit Service 4684c1
#endif
Packit Service 4684c1
#if _GL_HAS_BUILTIN_MUL_OVERFLOW
Packit Service 4684c1
# if (9 < __GNUC__ + (3 <= __GNUC_MINOR__) \
Packit Service 4684c1
      || (__GNUC__ == 8 && 4 <= __GNUC_MINOR__))
Packit Service 4684c1
#  define INT_MULTIPLY_WRAPV(a, b, r) __builtin_mul_overflow (a, b, r)
Packit Service 4684c1
# else
Packit Service 4684c1
   /* Work around GCC bug 91450.  */
Packit Service 4684c1
#  define INT_MULTIPLY_WRAPV(a, b, r) \
Packit Service 4684c1
    ((!_GL_SIGNED_TYPE_OR_EXPR (*(r)) && EXPR_SIGNED (a) && EXPR_SIGNED (b) \
Packit Service 4684c1
      && _GL_INT_MULTIPLY_RANGE_OVERFLOW (a, b, 0, (__typeof__ (*(r))) -1)) \
Packit Service 4684c1
     ? ((void) __builtin_mul_overflow (a, b, r), 1) \
Packit Service 4684c1
     : __builtin_mul_overflow (a, b, r))
Packit Service 4684c1
# endif
Packit Service 4684c1
#else
Packit Service 4684c1
# define INT_MULTIPLY_WRAPV(a, b, r) \
Packit Service 4684c1
   _GL_INT_OP_WRAPV (a, b, r, *, _GL_INT_MULTIPLY_RANGE_OVERFLOW)
Packit Service 4684c1
#endif
Packit Service 4684c1
Packit Service 4684c1
/* Nonzero if this compiler has GCC bug 68193 or Clang bug 25390.  See:
Packit Service 4684c1
   https://gcc.gnu.org/bugzilla/show_bug.cgi?id=68193
Packit Service 4684c1
   https://llvm.org/bugs/show_bug.cgi?id=25390
Packit Service 4684c1
   For now, assume all versions of GCC-like compilers generate bogus
Packit Service 4684c1
   warnings for _Generic.  This matters only for compilers that
Packit Service 4684c1
   lack relevant builtins.  */
Packit Service 4684c1
#if __GNUC__
Packit Service 4684c1
# define _GL__GENERIC_BOGUS 1
Packit Service 4684c1
#else
Packit Service 4684c1
# define _GL__GENERIC_BOGUS 0
Packit Service 4684c1
#endif
Packit Service 4684c1
Packit Service 4684c1
/* Store the low-order bits of A <op> B into *R, where OP specifies
Packit Service 4684c1
   the operation and OVERFLOW the overflow predicate.  Return 1 if the
Packit Service 4684c1
   result overflows.  See above for restrictions.  */
Packit Service 4684c1
#if 201112 <= __STDC_VERSION__ && !_GL__GENERIC_BOGUS
Packit Service 4684c1
# define _GL_INT_OP_WRAPV(a, b, r, op, overflow) \
Packit Service 4684c1
   (_Generic \
Packit Service 4684c1
    (*(r), \
Packit Service 4684c1
     signed char: \
Packit Service 4684c1
       _GL_INT_OP_CALC (a, b, r, op, overflow, unsigned int, \
Packit Service 4684c1
                        signed char, SCHAR_MIN, SCHAR_MAX), \
Packit Service 4684c1
     unsigned char: \
Packit Service 4684c1
       _GL_INT_OP_CALC (a, b, r, op, overflow, unsigned int, \
Packit Service 4684c1
                        unsigned char, 0, UCHAR_MAX), \
Packit Service 4684c1
     short int: \
Packit Service 4684c1
       _GL_INT_OP_CALC (a, b, r, op, overflow, unsigned int, \
Packit Service 4684c1
                        short int, SHRT_MIN, SHRT_MAX), \
Packit Service 4684c1
     unsigned short int: \
Packit Service 4684c1
       _GL_INT_OP_CALC (a, b, r, op, overflow, unsigned int, \
Packit Service 4684c1
                        unsigned short int, 0, USHRT_MAX), \
Packit Service 4684c1
     int: \
Packit Service 4684c1
       _GL_INT_OP_CALC (a, b, r, op, overflow, unsigned int, \
Packit Service 4684c1
                        int, INT_MIN, INT_MAX), \
Packit Service 4684c1
     unsigned int: \
Packit Service 4684c1
       _GL_INT_OP_CALC (a, b, r, op, overflow, unsigned int, \
Packit Service 4684c1
                        unsigned int, 0, UINT_MAX), \
Packit Service 4684c1
     long int: \
Packit Service 4684c1
       _GL_INT_OP_CALC (a, b, r, op, overflow, unsigned long int, \
Packit Service 4684c1
                        long int, LONG_MIN, LONG_MAX), \
Packit Service 4684c1
     unsigned long int: \
Packit Service 4684c1
       _GL_INT_OP_CALC (a, b, r, op, overflow, unsigned long int, \
Packit Service 4684c1
                        unsigned long int, 0, ULONG_MAX), \
Packit Service 4684c1
     long long int: \
Packit Service 4684c1
       _GL_INT_OP_CALC (a, b, r, op, overflow, unsigned long long int, \
Packit Service 4684c1
                        long long int, LLONG_MIN, LLONG_MAX), \
Packit Service 4684c1
     unsigned long long int: \
Packit Service 4684c1
       _GL_INT_OP_CALC (a, b, r, op, overflow, unsigned long long int, \
Packit Service 4684c1
                        unsigned long long int, 0, ULLONG_MAX)))
Packit Service 4684c1
#else
Packit Service 4684c1
/* Store the low-order bits of A <op> B into *R, where OP specifies
Packit Service 4684c1
   the operation and OVERFLOW the overflow predicate.  If *R is
Packit Service 4684c1
   signed, its type is ST with bounds SMIN..SMAX; otherwise its type
Packit Service 4684c1
   is UT with bounds U..UMAX.  ST and UT are narrower than int.
Packit Service 4684c1
   Return 1 if the result overflows.  See above for restrictions.  */
Packit Service 4684c1
# if _GL_HAVE___TYPEOF__
Packit Service 4684c1
#  define _GL_INT_OP_WRAPV_SMALLISH(a,b,r,op,overflow,st,smin,smax,ut,umax) \
Packit Service 4684c1
    (TYPE_SIGNED (__typeof__ (*(r))) \
Packit Service 4684c1
     ? _GL_INT_OP_CALC (a, b, r, op, overflow, unsigned int, st, smin, smax) \
Packit Service 4684c1
     : _GL_INT_OP_CALC (a, b, r, op, overflow, unsigned int, ut, 0, umax))
Packit Service 4684c1
# else
Packit Service 4684c1
#  define _GL_INT_OP_WRAPV_SMALLISH(a,b,r,op,overflow,st,smin,smax,ut,umax) \
Packit Service 4684c1
    (overflow (a, b, smin, smax) \
Packit Service 4684c1
     ? (overflow (a, b, 0, umax) \
Packit Service 4684c1
        ? (*(r) = _GL_INT_OP_WRAPV_VIA_UNSIGNED (a,b,op,unsigned,st), 1) \
Packit Service 4684c1
        : (*(r) = _GL_INT_OP_WRAPV_VIA_UNSIGNED (a,b,op,unsigned,st)) < 0) \
Packit Service 4684c1
     : (overflow (a, b, 0, umax) \
Packit Service 4684c1
        ? (*(r) = _GL_INT_OP_WRAPV_VIA_UNSIGNED (a,b,op,unsigned,st)) >= 0 \
Packit Service 4684c1
        : (*(r) = _GL_INT_OP_WRAPV_VIA_UNSIGNED (a,b,op,unsigned,st), 0)))
Packit Service 4684c1
# endif
Packit Service 4684c1
Packit Service 4684c1
# define _GL_INT_OP_WRAPV(a, b, r, op, overflow) \
Packit Service 4684c1
   (sizeof *(r) == sizeof (signed char) \
Packit Service 4684c1
    ? _GL_INT_OP_WRAPV_SMALLISH (a, b, r, op, overflow, \
Packit Service 4684c1
                                 signed char, SCHAR_MIN, SCHAR_MAX, \
Packit Service 4684c1
                                 unsigned char, UCHAR_MAX) \
Packit Service 4684c1
    : sizeof *(r) == sizeof (short int) \
Packit Service 4684c1
    ? _GL_INT_OP_WRAPV_SMALLISH (a, b, r, op, overflow, \
Packit Service 4684c1
                                 short int, SHRT_MIN, SHRT_MAX, \
Packit Service 4684c1
                                 unsigned short int, USHRT_MAX) \
Packit Service 4684c1
    : sizeof *(r) == sizeof (int) \
Packit Service 4684c1
    ? (EXPR_SIGNED (*(r)) \
Packit Service 4684c1
       ? _GL_INT_OP_CALC (a, b, r, op, overflow, unsigned int, \
Packit Service 4684c1
                          int, INT_MIN, INT_MAX) \
Packit Service 4684c1
       : _GL_INT_OP_CALC (a, b, r, op, overflow, unsigned int, \
Packit Service 4684c1
                          unsigned int, 0, UINT_MAX)) \
Packit Service 4684c1
    : _GL_INT_OP_WRAPV_LONGISH(a, b, r, op, overflow))
Packit Service 4684c1
# ifdef LLONG_MAX
Packit Service 4684c1
#  define _GL_INT_OP_WRAPV_LONGISH(a, b, r, op, overflow) \
Packit Service 4684c1
    (sizeof *(r) == sizeof (long int) \
Packit Service 4684c1
     ? (EXPR_SIGNED (*(r)) \
Packit Service 4684c1
        ? _GL_INT_OP_CALC (a, b, r, op, overflow, unsigned long int, \
Packit Service 4684c1
                           long int, LONG_MIN, LONG_MAX) \
Packit Service 4684c1
        : _GL_INT_OP_CALC (a, b, r, op, overflow, unsigned long int, \
Packit Service 4684c1
                           unsigned long int, 0, ULONG_MAX)) \
Packit Service 4684c1
     : (EXPR_SIGNED (*(r)) \
Packit Service 4684c1
        ? _GL_INT_OP_CALC (a, b, r, op, overflow, unsigned long long int, \
Packit Service 4684c1
                           long long int, LLONG_MIN, LLONG_MAX) \
Packit Service 4684c1
        : _GL_INT_OP_CALC (a, b, r, op, overflow, unsigned long long int, \
Packit Service 4684c1
                           unsigned long long int, 0, ULLONG_MAX)))
Packit Service 4684c1
# else
Packit Service 4684c1
#  define _GL_INT_OP_WRAPV_LONGISH(a, b, r, op, overflow) \
Packit Service 4684c1
    (EXPR_SIGNED (*(r)) \
Packit Service 4684c1
     ? _GL_INT_OP_CALC (a, b, r, op, overflow, unsigned long int, \
Packit Service 4684c1
                        long int, LONG_MIN, LONG_MAX) \
Packit Service 4684c1
     : _GL_INT_OP_CALC (a, b, r, op, overflow, unsigned long int, \
Packit Service 4684c1
                        unsigned long int, 0, ULONG_MAX))
Packit Service 4684c1
# endif
Packit Service 4684c1
#endif
Packit Service 4684c1
Packit Service 4684c1
/* Store the low-order bits of A <op> B into *R, where the operation
Packit Service 4684c1
   is given by OP.  Use the unsigned type UT for calculation to avoid
Packit Service 4684c1
   overflow problems.  *R's type is T, with extrema TMIN and TMAX.
Packit Service 4684c1
   T must be a signed integer type.  Return 1 if the result overflows.  */
Packit Service 4684c1
#define _GL_INT_OP_CALC(a, b, r, op, overflow, ut, t, tmin, tmax) \
Packit Service 4684c1
  (overflow (a, b, tmin, tmax) \
Packit Service 4684c1
   ? (*(r) = _GL_INT_OP_WRAPV_VIA_UNSIGNED (a, b, op, ut, t), 1) \
Packit Service 4684c1
   : (*(r) = _GL_INT_OP_WRAPV_VIA_UNSIGNED (a, b, op, ut, t), 0))
Packit Service 4684c1
Packit Service 4684c1
/* Return the low-order bits of A <op> B, where the operation is given
Packit Service 4684c1
   by OP.  Use the unsigned type UT for calculation to avoid undefined
Packit Service 4684c1
   behavior on signed integer overflow, and convert the result to type T.
Packit Service 4684c1
   UT is at least as wide as T and is no narrower than unsigned int,
Packit Service 4684c1
   T is two's complement, and there is no padding or trap representations.
Packit Service 4684c1
   Assume that converting UT to T yields the low-order bits, as is
Packit Service 4684c1
   done in all known two's-complement C compilers.  E.g., see:
Packit Service 4684c1
   https://gcc.gnu.org/onlinedocs/gcc/Integers-implementation.html
Packit Service 4684c1
Packit Service 4684c1
   According to the C standard, converting UT to T yields an
Packit Service 4684c1
   implementation-defined result or signal for values outside T's
Packit Service 4684c1
   range.  However, code that works around this theoretical problem
Packit Service 4684c1
   runs afoul of a compiler bug in Oracle Studio 12.3 x86.  See:
Packit Service 4684c1
   https://lists.gnu.org/r/bug-gnulib/2017-04/msg00049.html
Packit Service 4684c1
   As the compiler bug is real, don't try to work around the
Packit Service 4684c1
   theoretical problem.  */
Packit Service 4684c1
Packit Service 4684c1
#define _GL_INT_OP_WRAPV_VIA_UNSIGNED(a, b, op, ut, t) \
Packit Service 4684c1
  ((t) ((ut) (a) op (ut) (b)))
Packit Service 4684c1
Packit Service 4684c1
/* Return true if the numeric values A + B, A - B, A * B fall outside
Packit Service 4684c1
   the range TMIN..TMAX.  Arguments should be integer expressions
Packit Service 4684c1
   without side effects.  TMIN should be signed and nonpositive.
Packit Service 4684c1
   TMAX should be positive, and should be signed unless TMIN is zero.  */
Packit Service 4684c1
#define _GL_INT_ADD_RANGE_OVERFLOW(a, b, tmin, tmax) \
Packit Service 4684c1
  ((b) < 0 \
Packit Service 4684c1
   ? (((tmin) \
Packit Service 4684c1
       ? ((EXPR_SIGNED (_GL_INT_CONVERT (a, (tmin) - (b))) || (b) < (tmin)) \
Packit Service 4684c1
          && (a) < (tmin) - (b)) \
Packit Service 4684c1
       : (a) <= -1 - (b)) \
Packit Service 4684c1
      || ((EXPR_SIGNED (a) ? 0 <= (a) : (tmax) < (a)) && (tmax) < (a) + (b))) \
Packit Service 4684c1
   : (a) < 0 \
Packit Service 4684c1
   ? (((tmin) \
Packit Service 4684c1
       ? ((EXPR_SIGNED (_GL_INT_CONVERT (b, (tmin) - (a))) || (a) < (tmin)) \
Packit Service 4684c1
          && (b) < (tmin) - (a)) \
Packit Service 4684c1
       : (b) <= -1 - (a)) \
Packit Service 4684c1
      || ((EXPR_SIGNED (_GL_INT_CONVERT (a, b)) || (tmax) < (b)) \
Packit Service 4684c1
          && (tmax) < (a) + (b))) \
Packit Service 4684c1
   : (tmax) < (b) || (tmax) - (b) < (a))
Packit Service 4684c1
#define _GL_INT_SUBTRACT_RANGE_OVERFLOW(a, b, tmin, tmax) \
Packit Service 4684c1
  (((a) < 0) == ((b) < 0) \
Packit Service 4684c1
   ? ((a) < (b) \
Packit Service 4684c1
      ? !(tmin) || -1 - (tmin) < (b) - (a) - 1 \
Packit Service 4684c1
      : (tmax) < (a) - (b)) \
Packit Service 4684c1
   : (a) < 0 \
Packit Service 4684c1
   ? ((!EXPR_SIGNED (_GL_INT_CONVERT ((a) - (tmin), b)) && (a) - (tmin) < 0) \
Packit Service 4684c1
      || (a) - (tmin) < (b)) \
Packit Service 4684c1
   : ((! (EXPR_SIGNED (_GL_INT_CONVERT (tmax, b)) \
Packit Service 4684c1
          && EXPR_SIGNED (_GL_INT_CONVERT ((tmax) + (b), a))) \
Packit Service 4684c1
       && (tmax) <= -1 - (b)) \
Packit Service 4684c1
      || (tmax) + (b) < (a)))
Packit Service 4684c1
#define _GL_INT_MULTIPLY_RANGE_OVERFLOW(a, b, tmin, tmax) \
Packit Service 4684c1
  ((b) < 0 \
Packit Service 4684c1
   ? ((a) < 0 \
Packit Service 4684c1
      ? (EXPR_SIGNED (_GL_INT_CONVERT (tmax, b)) \
Packit Service 4684c1
         ? (a) < (tmax) / (b) \
Packit Service 4684c1
         : ((INT_NEGATE_OVERFLOW (b) \
Packit Service 4684c1
             ? _GL_INT_CONVERT (b, tmax) >> (TYPE_WIDTH (b) - 1) \
Packit Service 4684c1
             : (tmax) / -(b)) \
Packit Service 4684c1
            <= -1 - (a))) \
Packit Service 4684c1
      : INT_NEGATE_OVERFLOW (_GL_INT_CONVERT (b, tmin)) && (b) == -1 \
Packit Service 4684c1
      ? (EXPR_SIGNED (a) \
Packit Service 4684c1
         ? 0 < (a) + (tmin) \
Packit Service 4684c1
         : 0 < (a) && -1 - (tmin) < (a) - 1) \
Packit Service 4684c1
      : (tmin) / (b) < (a)) \
Packit Service 4684c1
   : (b) == 0 \
Packit Service 4684c1
   ? 0 \
Packit Service 4684c1
   : ((a) < 0 \
Packit Service 4684c1
      ? (INT_NEGATE_OVERFLOW (_GL_INT_CONVERT (a, tmin)) && (a) == -1 \
Packit Service 4684c1
         ? (EXPR_SIGNED (b) ? 0 < (b) + (tmin) : -1 - (tmin) < (b) - 1) \
Packit Service 4684c1
         : (tmin) / (a) < (b)) \
Packit Service 4684c1
      : (tmax) / (b) < (a)))
Packit Service 4684c1
Packit Service 4684c1
#endif /* _GL_INTPROPS_H */