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
   7 /*
   8  * In the fallback code below, we need to compute the minimum and
   9  * maximum values representable in a given type. These macros may also
  10  * be useful elsewhere, so we provide them outside the
  11  * COMPILER_HAS_GENERIC_BUILTIN_OVERFLOW block.
  12  *
  13  * It would seem more obvious to do something like
  14  *
  15  * #define type_min(T) (T)(is_signed_type(T) ? (T)1 << (8*sizeof(T)-1) : 0)
  16  * #define type_max(T) (T)(is_signed_type(T) ? ((T)1 << (8*sizeof(T)-1)) - 1 : ~(T)0)
  17  *
  18  * Unfortunately, the middle expressions, strictly speaking, have
  19  * undefined behaviour, and at least some versions of gcc warn about
  20  * the type_max expression (but not if -fsanitize=undefined is in
  21  * effect; in that case, the warning is deferred to runtime...).
  22  *
  23  * The slightly excessive casting in type_min is to make sure the
  24  * macros also produce sensible values for the exotic type _Bool. [The
  25  * overflow checkers only almost work for _Bool, but that's
  26  * a-feature-not-a-bug, since people shouldn't be doing arithmetic on
  27  * _Bools. Besides, the gcc builtins don't allow _Bool* as third
  28  * argument.]
  29  *
  30  * Idea stolen from
  31  * https://mail-index.netbsd.org/tech-misc/2007/02/05/0000.html -
  32  * credit to Christian Biere.
  33  */
  34 #define is_signed_type(type)       (((type)(-1)) < (type)1)
  35 #define __type_half_max(type) ((type)1 << (8*sizeof(type) - 1 - is_signed_type(type)))
  36 #define type_max(T) ((T)((__type_half_max(T) - 1) + __type_half_max(T)))
  37 #define type_min(T) ((T)((T)-type_max(T)-(T)1))
  38
  39 /*
  40  * Avoids triggering -Wtype-limits compilation warning,
  41  * while using unsigned data types to check a < 0.
  42  */
  43 #define is_non_negative(a) ((a) > 0 || (a) == 0)
  44 #define is_negative(a) (!(is_non_negative(a)))
  45
  46 /*
  47  * Allows for effectively applying __must_check to a macro so we can have
  48  * both the type-agnostic benefits of the macros while also being able to
  49  * enforce that the return value is, in fact, checked.
  50  */
  51 static inline bool __must_check __must_check_overflow(bool overflow)
  52 {
  53         return unlikely(overflow);
  54 }
  55
  56 #ifdef COMPILER_HAS_GENERIC_BUILTIN_OVERFLOW
  57 /*
  58  * For simplicity and code hygiene, the fallback code below insists on
  59  * a, b and *d having the same type (similar to the min() and max()
  60  * macros), whereas gcc's type-generic overflow checkers accept
  61  * different types. Hence we don't just make check_add_overflow an
  62  * alias for __builtin_add_overflow, but add type checks similar to
  63  * below.
  64  */
  65 #define check_add_overflow(a, b, d) __must_check_overflow(({    \
  66         typeof(a) __a = (a);                    \
  67         typeof(b) __b = (b);                    \
  68         typeof(d) __d = (d);                    \
  69         (void) (&__a == &__b);                  \
  70         (void) (&__a == __d);                   \
  71         __builtin_add_overflow(__a, __b, __d);  \
  72 }))
  73
  74 #define check_sub_overflow(a, b, d) __must_check_overflow(({    \
  75         typeof(a) __a = (a);                    \
  76         typeof(b) __b = (b);                    \
  77         typeof(d) __d = (d);                    \
  78         (void) (&__a == &__b);                  \
  79         (void) (&__a == __d);                   \
  80         __builtin_sub_overflow(__a, __b, __d);  \
  81 }))
  82
  83 #define check_mul_overflow(a, b, d) __must_check_overflow(({    \
  84         typeof(a) __a = (a);                    \
  85         typeof(b) __b = (b);                    \
  86         typeof(d) __d = (d);                    \
  87         (void) (&__a == &__b);                  \
  88         (void) (&__a == __d);                   \
  89         __builtin_mul_overflow(__a, __b, __d);  \
  90 }))
  91
  92 #else
  93
  94
  95 /* Checking for unsigned overflow is relatively easy without causing UB. */
  96 #define __unsigned_add_overflow(a, b, d) ({     \
  97         typeof(a) __a = (a);                    \
  98         typeof(b) __b = (b);                    \
  99         typeof(d) __d = (d);                    \
 100         (void) (&__a == &__b);                  \
 101         (void) (&__a == __d);                   \
 102         *__d = __a + __b;                       \
 103         *__d < __a;                             \
 104 })
 105 #define __unsigned_sub_overflow(a, b, d) ({     \
 106         typeof(a) __a = (a);                    \
 107         typeof(b) __b = (b);                    \
 108         typeof(d) __d = (d);                    \
 109         (void) (&__a == &__b);                  \
 110         (void) (&__a == __d);                   \
 111         *__d = __a - __b;                       \
 112         __a < __b;                              \
 113 })
 114 /*
 115  * If one of a or b is a compile-time constant, this avoids a division.
 116  */
 117 #define __unsigned_mul_overflow(a, b, d) ({             \
 118         typeof(a) __a = (a);                            \
 119         typeof(b) __b = (b);                            \
 120         typeof(d) __d = (d);                            \
 121         (void) (&__a == &__b);                          \
 122         (void) (&__a == __d);                           \
 123         *__d = __a * __b;                               \
 124         __builtin_constant_p(__b) ?                     \
 125           __b > 0 && __a > type_max(typeof(__a)) / __b : \
 126           __a > 0 && __b > type_max(typeof(__b)) / __a;  \
 127 })
 128
 129 /*
 130  * For signed types, detecting overflow is much harder, especially if
 131  * we want to avoid UB. But the interface of these macros is such that
 132  * we must provide a result in *d, and in fact we must produce the
 133  * result promised by gcc's builtins, which is simply the possibly
 134  * wrapped-around value. Fortunately, we can just formally do the
 135  * operations in the widest relevant unsigned type (u64) and then
 136  * truncate the result - gcc is smart enough to generate the same code
 137  * with and without the (u64) casts.
 138  */
 139
 140 /*
 141  * Adding two signed integers can overflow only if they have the same
 142  * sign, and overflow has happened iff the result has the opposite
 143  * sign.
 144  */
 145 #define __signed_add_overflow(a, b, d) ({       \
 146         typeof(a) __a = (a);                    \
 147         typeof(b) __b = (b);                    \
 148         typeof(d) __d = (d);                    \
 149         (void) (&__a == &__b);                  \
 150         (void) (&__a == __d);                   \
 151         *__d = (u64)__a + (u64)__b;             \
 152         (((~(__a ^ __b)) & (*__d ^ __a))        \
 153                 & type_min(typeof(__a))) != 0;  \
 154 })
 155
 156 /*
 157  * Subtraction is similar, except that overflow can now happen only
 158  * when the signs are opposite. In this case, overflow has happened if
 159  * the result has the opposite sign of a.
 160  */
 161 #define __signed_sub_overflow(a, b, d) ({       \
 162         typeof(a) __a = (a);                    \
 163         typeof(b) __b = (b);                    \
 164         typeof(d) __d = (d);                    \
 165         (void) (&__a == &__b);                  \
 166         (void) (&__a == __d);                   \
 167         *__d = (u64)__a - (u64)__b;             \
 168         ((((__a ^ __b)) & (*__d ^ __a))         \
 169                 & type_min(typeof(__a))) != 0;  \
 170 })
 171
 172 /*
 173  * Signed multiplication is rather hard. gcc always follows C99, so
 174  * division is truncated towards 0. This means that we can write the
 175  * overflow check like this:
 176  *
 177  * (a > 0 && (b > MAX/a || b < MIN/a)) ||
 178  * (a < -1 && (b > MIN/a || b < MAX/a) ||
 179  * (a == -1 && b == MIN)
 180  *
 181  * The redundant casts of -1 are to silence an annoying -Wtype-limits
 182  * (included in -Wextra) warning: When the type is u8 or u16, the
 183  * __b_c_e in check_mul_overflow obviously selects
 184  * __unsigned_mul_overflow, but unfortunately gcc still parses this
 185  * code and warns about the limited range of __b.
 186  */
 187
 188 #define __signed_mul_overflow(a, b, d) ({                               \
 189         typeof(a) __a = (a);                                            \
 190         typeof(b) __b = (b);                                            \
 191         typeof(d) __d = (d);                                            \
 192         typeof(a) __tmax = type_max(typeof(a));                         \
 193         typeof(a) __tmin = type_min(typeof(a));                         \
 194         (void) (&__a == &__b);                                          \
 195         (void) (&__a == __d);                                           \
 196         *__d = (u64)__a * (u64)__b;                                     \
 197         (__b > 0   && (__a > __tmax/__b || __a < __tmin/__b)) ||        \
 198         (__b < (typeof(__b))-1  && (__a > __tmin/__b || __a < __tmax/__b)) || \
 199         (__b == (typeof(__b))-1 && __a == __tmin);                      \
 200 })
 201
 202
 203 #define check_add_overflow(a, b, d)     __must_check_overflow(          \
 204         __builtin_choose_expr(is_signed_type(typeof(a)),                \
 205                         __signed_add_overflow(a, b, d),                 \
 206                         __unsigned_add_overflow(a, b, d)))
 207
 208 #define check_sub_overflow(a, b, d)     __must_check_overflow(          \
 209         __builtin_choose_expr(is_signed_type(typeof(a)),                \
 210                         __signed_sub_overflow(a, b, d),                 \
 211                         __unsigned_sub_overflow(a, b, d)))
 212
 213 #define check_mul_overflow(a, b, d)     __must_check_overflow(          \
 214         __builtin_choose_expr(is_signed_type(typeof(a)),                \
 215                         __signed_mul_overflow(a, b, d),                 \
 216                         __unsigned_mul_overflow(a, b, d)))
 217
 218 #endif /* COMPILER_HAS_GENERIC_BUILTIN_OVERFLOW */
 219
 220 /** check_shl_overflow() - Calculate a left-shifted value and check overflow
 221  *
 222  * @a: Value to be shifted
 223  * @s: How many bits left to shift
 224  * @d: Pointer to where to store the result
 225  *
 226  * Computes *@d = (@a << @s)
 227  *
 228  * Returns true if '*d' cannot hold the result or when 'a << s' doesn't
 229  * make sense. Example conditions:
 230  * - 'a << s' causes bits to be lost when stored in *d.
 231  * - 's' is garbage (e.g. negative) or so large that the result of
 232  *   'a << s' is guaranteed to be 0.
 233  * - 'a' is negative.
 234  * - 'a << s' sets the sign bit, if any, in '*d'.
 235  *
 236  * '*d' will hold the results of the attempted shift, but is not
 237  * considered "safe for use" if false is returned.
 238  */
 239 #define check_shl_overflow(a, s, d) __must_check_overflow(({            \
 240         typeof(a) _a = a;                                               \
 241         typeof(s) _s = s;                                               \
 242         typeof(d) _d = d;                                               \
 243         u64 _a_full = _a;                                               \
 244         unsigned int _to_shift =                                        \
 245                 is_non_negative(_s) && _s < 8 * sizeof(*d) ? _s : 0;    \
 246         *_d = (_a_full << _to_shift);                                   \
 247         (_to_shift != _s || is_negative(*_d) || is_negative(_a) ||      \
 248         (*_d >> _to_shift) != _a);                                      \
 249 }))
 250
 251 /**
 252  * array_size() - Calculate size of 2-dimensional array.
 253  *
 254  * @a: dimension one
 255  * @b: dimension two
 256  *
 257  * Calculates size of 2-dimensional array: @a * @b.
 258  *
 259  * Returns: number of bytes needed to represent the array or SIZE_MAX on
 260  * overflow.
 261  */
 262 static inline __must_check size_t array_size(size_t a, size_t b)
 263 {
 264         size_t bytes;
 265
 266         if (check_mul_overflow(a, b, &bytes))
 267                 return SIZE_MAX;
 268
 269         return bytes;
 270 }
 271
 272 /**
 273  * array3_size() - Calculate size of 3-dimensional array.
 274  *
 275  * @a: dimension one
 276  * @b: dimension two
 277  * @c: dimension three
 278  *
 279  * Calculates size of 3-dimensional array: @a * @b * @c.
 280  *
 281  * Returns: number of bytes needed to represent the array or SIZE_MAX on
 282  * overflow.
 283  */
 284 static inline __must_check size_t array3_size(size_t a, size_t b, size_t c)
 285 {
 286         size_t bytes;
 287
 288         if (check_mul_overflow(a, b, &bytes))
 289                 return SIZE_MAX;
 290         if (check_mul_overflow(bytes, c, &bytes))
 291                 return SIZE_MAX;
 292
 293         return bytes;
 294 }
 295
 296 /*
 297  * Compute a*b+c, returning SIZE_MAX on overflow. Internal helper for
 298  * struct_size() below.
 299  */
 300 static inline __must_check size_t __ab_c_size(size_t a, size_t b, size_t c)
 301 {
 302         size_t bytes;
 303
 304         if (check_mul_overflow(a, b, &bytes))
 305                 return SIZE_MAX;
 306         if (check_add_overflow(bytes, c, &bytes))
 307                 return SIZE_MAX;
 308
 309         return bytes;
 310 }
 311
 312 /**
 313  * struct_size() - Calculate size of structure with trailing array.
 314  * @p: Pointer to the structure.
 315  * @member: Name of the array member.
 316  * @count: Number of elements in the array.
 317  *
 318  * Calculates size of memory needed for structure @p followed by an
 319  * array of @count number of @member elements.
 320  *
 321  * Return: number of bytes needed or SIZE_MAX on overflow.
 322  */
 323 #define struct_size(p, member, count)                                   \
 324         __ab_c_size(count,                                              \
 325                     sizeof(*(p)->member) + __must_be_array((p)->member),\
 326                     sizeof(*(p)))
 327
 328 /**
 329  * flex_array_size() - Calculate size of a flexible array member
 330  *                     within an enclosing structure.
 331  *
 332  * @p: Pointer to the structure.
 333  * @member: Name of the flexible array member.
 334  * @count: Number of elements in the array.
 335  *
 336  * Calculates size of a flexible array of @count number of @member
 337  * elements, at the end of structure @p.
 338  *
 339  * Return: number of bytes needed or SIZE_MAX on overflow.
 340  */
 341 #define flex_array_size(p, member, count)                               \
 342         array_size(count,                                               \
 343                     sizeof(*(p)->member) + __must_be_array((p)->member))
 344
 345 #endif /* __LINUX_OVERFLOW_H */