include/linux/overflow.h

   1 /* SPDX-License-Identifier: GPL-2.0 OR MIT */
   2 #ifndef __LINUX_OVERFLOW_H
   3 #define __LINUX_OVERFLOW_H
   4
   5 #include <linux/compiler.h>
   6 #include <linux/limits.h>
   7 #include <linux/const.h>
   8
   9 /*
  10  * We need to compute the minimum and maximum values representable in a given
  11  * type. These macros may also be useful elsewhere. It would seem more obvious
  12  * to do something like:
  13  *
  14  * #define type_min(T) (T)(is_signed_type(T) ? (T)1 << (8*sizeof(T)-1) : 0)
  15  * #define type_max(T) (T)(is_signed_type(T) ? ((T)1 << (8*sizeof(T)-1)) - 1 : ~(T)0)
  16  *
  17  * Unfortunately, the middle expressions, strictly speaking, have
  18  * undefined behaviour, and at least some versions of gcc warn about
  19  * the type_max expression (but not if -fsanitize=undefined is in
  20  * effect; in that case, the warning is deferred to runtime...).
  21  *
  22  * The slightly excessive casting in type_min is to make sure the
  23  * macros also produce sensible values for the exotic type _Bool. [The
  24  * overflow checkers only almost work for _Bool, but that's
  25  * a-feature-not-a-bug, since people shouldn't be doing arithmetic on
  26  * _Bools. Besides, the gcc builtins don't allow _Bool* as third
  27  * argument.]
  28  *
  29  * Idea stolen from
  30  * https://mail-index.netbsd.org/tech-misc/2007/02/05/0000.html -
  31  * credit to Christian Biere.
  32  */
  33 #define __type_half_max(type) ((type)1 << (8*sizeof(type) - 1 - is_signed_type(type)))
  34 #define type_max(T) ((T)((__type_half_max(T) - 1) + __type_half_max(T)))
  35 #define type_min(T) ((T)((T)-type_max(T)-(T)1))
  36
  37 /*
  38  * Avoids triggering -Wtype-limits compilation warning,
  39  * while using unsigned data types to check a < 0.
  40  */
  41 #define is_non_negative(a) ((a) > 0 || (a) == 0)
  42 #define is_negative(a) (!(is_non_negative(a)))
  43
  44 /*
  45  * Allows for effectively applying __must_check to a macro so we can have
  46  * both the type-agnostic benefits of the macros while also being able to
  47  * enforce that the return value is, in fact, checked.
  48  */
  49 static inline bool __must_check __must_check_overflow(bool overflow)
  50 {
  51         return unlikely(overflow);
  52 }
  53
  54 /*
  55  * For simplicity and code hygiene, the fallback code below insists on
  56  * a, b and *d having the same type (similar to the min() and max()
  57  * macros), whereas gcc's type-generic overflow checkers accept
  58  * different types. Hence we don't just make check_add_overflow an
  59  * alias for __builtin_add_overflow, but add type checks similar to
  60  * below.
  61  */
  62 #define check_add_overflow(a, b, d) __must_check_overflow(({    \
  63         typeof(a) __a = (a);                    \
  64         typeof(b) __b = (b);                    \
  65         typeof(d) __d = (d);                    \
  66         (void) (&__a == &__b);                  \
  67         (void) (&__a == __d);                   \
  68         __builtin_add_overflow(__a, __b, __d);  \
  69 }))
  70
  71 #define check_sub_overflow(a, b, d) __must_check_overflow(({    \
  72         typeof(a) __a = (a);                    \
  73         typeof(b) __b = (b);                    \
  74         typeof(d) __d = (d);                    \
  75         (void) (&__a == &__b);                  \
  76         (void) (&__a == __d);                   \
  77         __builtin_sub_overflow(__a, __b, __d);  \
  78 }))
  79
  80 #define check_mul_overflow(a, b, d) __must_check_overflow(({    \
  81         typeof(a) __a = (a);                    \
  82         typeof(b) __b = (b);                    \
  83         typeof(d) __d = (d);                    \
  84         (void) (&__a == &__b);                  \
  85         (void) (&__a == __d);                   \
  86         __builtin_mul_overflow(__a, __b, __d);  \
  87 }))
  88
  89 /** check_shl_overflow() - Calculate a left-shifted value and check overflow
  90  *
  91  * @a: Value to be shifted
  92  * @s: How many bits left to shift
  93  * @d: Pointer to where to store the result
  94  *
  95  * Computes *@d = (@a << @s)
  96  *
  97  * Returns true if '*d' cannot hold the result or when 'a << s' doesn't
  98  * make sense. Example conditions:
  99  * - 'a << s' causes bits to be lost when stored in *d.
 100  * - 's' is garbage (e.g. negative) or so large that the result of
 101  *   'a << s' is guaranteed to be 0.
 102  * - 'a' is negative.
 103  * - 'a << s' sets the sign bit, if any, in '*d'.
 104  *
 105  * '*d' will hold the results of the attempted shift, but is not
 106  * considered "safe for use" if true is returned.
 107  */
 108 #define check_shl_overflow(a, s, d) __must_check_overflow(({            \
 109         typeof(a) _a = a;                                               \
 110         typeof(s) _s = s;                                               \
 111         typeof(d) _d = d;                                               \
 112         u64 _a_full = _a;                                               \
 113         unsigned int _to_shift =                                        \
 114                 is_non_negative(_s) && _s < 8 * sizeof(*d) ? _s : 0;    \
 115         *_d = (_a_full << _to_shift);                                   \
 116         (_to_shift != _s || is_negative(*_d) || is_negative(_a) ||      \
 117         (*_d >> _to_shift) != _a);                                      \
 118 }))
 119
 120 /**
 121  * size_mul() - Calculate size_t multiplication with saturation at SIZE_MAX
 122  *
 123  * @factor1: first factor
 124  * @factor2: second factor
 125  *
 126  * Returns: calculate @factor1 * @factor2, both promoted to size_t,
 127  * with any overflow causing the return value to be SIZE_MAX. The
 128  * lvalue must be size_t to avoid implicit type conversion.
 129  */
 130 static inline size_t __must_check size_mul(size_t factor1, size_t factor2)
 131 {
 132         size_t bytes;
 133
 134         if (check_mul_overflow(factor1, factor2, &bytes))
 135                 return SIZE_MAX;
 136
 137         return bytes;
 138 }
 139
 140 /**
 141  * size_add() - Calculate size_t addition with saturation at SIZE_MAX
 142  *
 143  * @addend1: first addend
 144  * @addend2: second addend
 145  *
 146  * Returns: calculate @addend1 + @addend2, both promoted to size_t,
 147  * with any overflow causing the return value to be SIZE_MAX. The
 148  * lvalue must be size_t to avoid implicit type conversion.
 149  */
 150 static inline size_t __must_check size_add(size_t addend1, size_t addend2)
 151 {
 152         size_t bytes;
 153
 154         if (check_add_overflow(addend1, addend2, &bytes))
 155                 return SIZE_MAX;
 156
 157         return bytes;
 158 }
 159
 160 /**
 161  * size_sub() - Calculate size_t subtraction with saturation at SIZE_MAX
 162  *
 163  * @minuend: value to subtract from
 164  * @subtrahend: value to subtract from @minuend
 165  *
 166  * Returns: calculate @minuend - @subtrahend, both promoted to size_t,
 167  * with any overflow causing the return value to be SIZE_MAX. For
 168  * composition with the size_add() and size_mul() helpers, neither
 169  * argument may be SIZE_MAX (or the result with be forced to SIZE_MAX).
 170  * The lvalue must be size_t to avoid implicit type conversion.
 171  */
 172 static inline size_t __must_check size_sub(size_t minuend, size_t subtrahend)
 173 {
 174         size_t bytes;
 175
 176         if (minuend == SIZE_MAX || subtrahend == SIZE_MAX ||
 177             check_sub_overflow(minuend, subtrahend, &bytes))
 178                 return SIZE_MAX;
 179
 180         return bytes;
 181 }
 182
 183 /**
 184  * array_size() - Calculate size of 2-dimensional array.
 185  *
 186  * @a: dimension one
 187  * @b: dimension two
 188  *
 189  * Calculates size of 2-dimensional array: @a * @b.
 190  *
 191  * Returns: number of bytes needed to represent the array or SIZE_MAX on
 192  * overflow.
 193  */
 194 #define array_size(a, b)        size_mul(a, b)
 195
 196 /**
 197  * array3_size() - Calculate size of 3-dimensional array.
 198  *
 199  * @a: dimension one
 200  * @b: dimension two
 201  * @c: dimension three
 202  *
 203  * Calculates size of 3-dimensional array: @a * @b * @c.
 204  *
 205  * Returns: number of bytes needed to represent the array or SIZE_MAX on
 206  * overflow.
 207  */
 208 #define array3_size(a, b, c)    size_mul(size_mul(a, b), c)
 209
 210 /**
 211  * flex_array_size() - Calculate size of a flexible array member
 212  *                     within an enclosing structure.
 213  *
 214  * @p: Pointer to the structure.
 215  * @member: Name of the flexible array member.
 216  * @count: Number of elements in the array.
 217  *
 218  * Calculates size of a flexible array of @count number of @member
 219  * elements, at the end of structure @p.
 220  *
 221  * Return: number of bytes needed or SIZE_MAX on overflow.
 222  */
 223 #define flex_array_size(p, member, count)                               \
 224         __builtin_choose_expr(__is_constexpr(count),                    \
 225                 (count) * sizeof(*(p)->member) + __must_be_array((p)->member),  \
 226                 size_mul(count, sizeof(*(p)->member) + __must_be_array((p)->member)))
 227
 228 /**
 229  * struct_size() - Calculate size of structure with trailing flexible array.
 230  *
 231  * @p: Pointer to the structure.
 232  * @member: Name of the array member.
 233  * @count: Number of elements in the array.
 234  *
 235  * Calculates size of memory needed for structure @p followed by an
 236  * array of @count number of @member elements.
 237  *
 238  * Return: number of bytes needed or SIZE_MAX on overflow.
 239  */
 240 #define struct_size(p, member, count)                                   \
 241         __builtin_choose_expr(__is_constexpr(count),                    \
 242                 sizeof(*(p)) + flex_array_size(p, member, count),       \
 243                 size_add(sizeof(*(p)), flex_array_size(p, member, count)))
 244
 245 #endif /* __LINUX_OVERFLOW_H */