ucx: src/cx/utils.h@0d3c6075f82c

     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  */

    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  */

    40 #ifndef UCX_UTILS_H

    41 #define UCX_UTILS_H

    43 #include "common.h"

    45 #ifdef __cplusplus

    46 extern "C" {

    47 #endif

    49 #define cx_for_n(varname, n) for (size_t varname = 0 ; (varname) < (n) ; (varname)++)

    51 /* ----------------------

    52  * cx_szmul() definition.

    53  * ---------------------- */

    55 #if (__GNUC__ >= 5 || defined(__clang__)) && !defined(CX_NO_SZMUL_BUILTIN)

    56 #define CX_SZMUL_BUILTIN

    58 #if __WORDSIZE == 32

    59 /**

    60  * Alias for \c __builtin_umul_overflow.

    61  *

    62  * Performs a multiplication of size_t values and checks for overflow.

    63  *

    64  * @param a first operand

    65  * @param b second operand

    66  * @param result a pointer to a size_t, where the result should

    67  * be stored

    68  * @return zero, if no overflow occurred and the result is correct, non-zero

    69  * otherwise

    70  */

    71 #define cx_szmul(a, b, result) __builtin_umul_overflow(a, b, result)

    72 #else /* __WORDSIZE != 32 */

    73 /**

    74  * Alias for \c __builtin_umull_overflow.

    75  *

    76  * Performs a multiplication of size_t values and checks for overflow.

    77  *

    78  * @param a first operand

    79  * @param b second operand

    80  * @param result a pointer to a size_t, where the result should

    81  * be stored

    82  * @return zero, if no overflow occurred and the result is correct, non-zero

    83  * otherwise

    84  */

    85 #define cx_szmul(a, b, result) __builtin_umull_overflow(a, b, result)

    86 #endif /* __WORDSIZE */

    88 #else /* no GNUC or clang bultin */

    90 /**

    91  * Performs a multiplication of size_t values and checks for overflow.

    92   *

    93  * @param a first operand

    94  * @param b second operand

    95  * @param result a pointer to a size_t, where the result should

    96  * be stored

    97  * @return zero, if no overflow occurred and the result is correct, non-zero

    98  * otherwise

    99  */

   100 #define cx_szmul(a, b, result) cx_szmul_impl(a, b, result)

   102 /**

   103  * Performs a multiplication of size_t values and checks for overflow.

   104  *

   105  * This is a custom implementation in case there is no compiler builtin

   106  * available.

   107  *

   108  * @param a first operand

   109  * @param b second operand

   110  * @param result a pointer to a size_t where the result should be stored

   111  * @return zero, if no overflow occurred and the result is correct, non-zero

   112  * otherwise

   113  */

   114 int cx_szmul_impl(size_t a, size_t b, size_t *result);

   116 #endif

   118 #ifdef __cplusplus

   119 }

   120 #endif

   122 #endif /* UCX_UTILS_H */

Mercurial > hg > ucx / file revision