comparison: src/cx/utils.h
src/cx/utils.h
- changeset 483
- 929016224c3c
- child 509
- 0d3c6075f82c
equal
deleted
inserted
replaced
| 482:0d998f19d130 | 483:929016224c3c |
|---|---|
| 1 /* | |
| 2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. | |
| 3 * | |
| 4 * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved. | |
| 5 * | |
| 6 * Redistribution and use in source and binary forms, with or without | |
| 7 * modification, are permitted provided that the following conditions are met: | |
| 8 * | |
| 9 * 1. Redistributions of source code must retain the above copyright | |
| 10 * notice, this list of conditions and the following disclaimer. | |
| 11 * | |
| 12 * 2. Redistributions in binary form must reproduce the above copyright | |
| 13 * notice, this list of conditions and the following disclaimer in the | |
| 14 * documentation and/or other materials provided with the distribution. | |
| 15 * | |
| 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | |
| 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
| 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
| 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE | |
| 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | |
| 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | |
| 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | |
| 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | |
| 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | |
| 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | |
| 26 * POSSIBILITY OF SUCH DAMAGE. | |
| 27 */ | |
| 28 | |
| 29 /** | |
| 30 * \file utils.h | |
| 31 * | |
| 32 * \brief General purpose utility functions. | |
| 33 * | |
| 34 * \author Mike Becker | |
| 35 * \author Olaf Wintermann | |
| 36 * \version 3.0 | |
| 37 * \copyright 2-Clause BSD License | |
| 38 */ | |
| 39 | |
| 40 #ifndef UCX_UTILS_H | |
| 41 #define UCX_UTILS_H | |
| 42 | |
| 43 #include "common.h" | |
| 44 | |
| 45 #ifdef __cplusplus | |
| 46 extern "C" { | |
| 47 #endif | |
| 48 | |
| 49 /* ---------------------- | |
| 50 * cx_szmul() definition. | |
| 51 * ---------------------- */ | |
| 52 | |
| 53 #if (__GNUC__ >= 5 || defined(__clang__)) && !defined(CX_NO_SZMUL_BUILTIN) | |
| 54 #define CX_SZMUL_BUILTIN | |
| 55 | |
| 56 #if __WORDSIZE == 32 | |
| 57 /** | |
| 58 * Alias for \c __builtin_umul_overflow. | |
| 59 * | |
| 60 * Performs a multiplication of size_t values and checks for overflow. | |
| 61 * | |
| 62 * @param a first operand | |
| 63 * @param b second operand | |
| 64 * @param result a pointer to a size_t, where the result should | |
| 65 * be stored | |
| 66 * @return zero, if no overflow occurred and the result is correct, non-zero | |
| 67 * otherwise | |
| 68 */ | |
| 69 #define cx_szmul(a, b, result) __builtin_umul_overflow(a, b, result) | |
| 70 #else /* __WORDSIZE != 32 */ | |
| 71 /** | |
| 72 * Alias for \c __builtin_umull_overflow. | |
| 73 * | |
| 74 * Performs a multiplication of size_t values and checks for overflow. | |
| 75 * | |
| 76 * @param a first operand | |
| 77 * @param b second operand | |
| 78 * @param result a pointer to a size_t, where the result should | |
| 79 * be stored | |
| 80 * @return zero, if no overflow occurred and the result is correct, non-zero | |
| 81 * otherwise | |
| 82 */ | |
| 83 #define cx_szmul(a, b, result) __builtin_umull_overflow(a, b, result) | |
| 84 #endif /* __WORDSIZE */ | |
| 85 | |
| 86 #else /* no GNUC or clang bultin */ | |
| 87 | |
| 88 /** | |
| 89 * Performs a multiplication of size_t values and checks for overflow. | |
| 90 * | |
| 91 * @param a first operand | |
| 92 * @param b second operand | |
| 93 * @param result a pointer to a size_t, where the result should | |
| 94 * be stored | |
| 95 * @return zero, if no overflow occurred and the result is correct, non-zero | |
| 96 * otherwise | |
| 97 */ | |
| 98 #define cx_szmul(a, b, result) cx_szmul_impl(a, b, result) | |
| 99 | |
| 100 /** | |
| 101 * Performs a multiplication of size_t values and checks for overflow. | |
| 102 * | |
| 103 * This is a custom implementation in case there is no compiler builtin | |
| 104 * available. | |
| 105 * | |
| 106 * @param a first operand | |
| 107 * @param b second operand | |
| 108 * @param result a pointer to a size_t where the result should be stored | |
| 109 * @return zero, if no overflow occurred and the result is correct, non-zero | |
| 110 * otherwise | |
| 111 */ | |
| 112 int cx_szmul_impl(size_t a, size_t b, size_t *result); | |
| 113 | |
| 114 #endif | |
| 115 | |
| 116 #ifdef __cplusplus | |
| 117 } | |
| 118 #endif | |
| 119 | |
| 120 #endif /* UCX_UTILS_H */ |
