comparison: src/ucx/cx/utils.h
src/ucx/cx/utils.h
- changeset 490
- d218607f5a7e
- parent 438
- 22eca559aded
- child 504
- c094afcdfb27
equal
deleted
inserted
replaced
| 489:921f83a8943f | 490:d218607f5a7e |
|---|---|
| 49 /** | 49 /** |
| 50 * Convenience macro for a for loop that counts from zero to n-1. | 50 * Convenience macro for a for loop that counts from zero to n-1. |
| 51 */ | 51 */ |
| 52 #define cx_for_n(varname, n) for (size_t varname = 0 ; (varname) < (n) ; (varname)++) | 52 #define cx_for_n(varname, n) for (size_t varname = 0 ; (varname) < (n) ; (varname)++) |
| 53 | 53 |
| 54 /** | |
| 55 * Convenience macro for swapping two pointers. | |
| 56 */ | |
| 57 #ifdef __cplusplus | |
| 58 #define cx_swap_ptr(left, right) do {auto cx_tmp_swap_var = left; left = right; right = cx_tmp_swap_var;} while(0) | |
| 59 #else | |
| 60 #define cx_swap_ptr(left, right) do {void *cx_tmp_swap_var = left; left = right; right = cx_tmp_swap_var;} while(0) | |
| 61 #endif | |
| 62 | |
| 54 // cx_szmul() definition | 63 // cx_szmul() definition |
| 55 | 64 |
| 56 #if (__GNUC__ >= 5 || defined(__clang__)) && !defined(CX_NO_SZMUL_BUILTIN) | 65 #if (__GNUC__ >= 5 || defined(__clang__)) && !defined(CX_NO_SZMUL_BUILTIN) |
| 57 #define CX_SZMUL_BUILTIN | 66 #define CX_SZMUL_BUILTIN |
| 58 | 67 |
| 59 #if __WORDSIZE == 32 | |
| 60 /** | 68 /** |
| 61 * Alias for \c __builtin_umul_overflow. | 69 * Alias for \c __builtin_mul_overflow. |
| 62 * | 70 * |
| 63 * Performs a multiplication of size_t values and checks for overflow. | 71 * Performs a multiplication of size_t values and checks for overflow. |
| 64 * | 72 * |
| 65 * @param a first operand | 73 * @param a first operand |
| 66 * @param b second operand | 74 * @param b second operand |
| 67 * @param result a pointer to a size_t, where the result should | 75 * @param result a pointer to a size_t, where the result should |
| 68 * be stored | 76 * be stored |
| 69 * @return zero, if no overflow occurred and the result is correct, non-zero | 77 * @return zero, if no overflow occurred and the result is correct, non-zero |
| 70 * otherwise | 78 * otherwise |
| 71 */ | 79 */ |
| 72 #define cx_szmul(a, b, result) __builtin_umul_overflow(a, b, result) | 80 #define cx_szmul(a, b, result) __builtin_mul_overflow(a, b, result) |
| 73 #else // __WORDSIZE != 32 | |
| 74 /** | |
| 75 * Alias for \c __builtin_umull_overflow. | |
| 76 * | |
| 77 * Performs a multiplication of size_t values and checks for overflow. | |
| 78 * | |
| 79 * @param a first operand | |
| 80 * @param b second operand | |
| 81 * @param result a pointer to a size_t, where the result should | |
| 82 * be stored | |
| 83 * @return zero, if no overflow occurred and the result is correct, non-zero | |
| 84 * otherwise | |
| 85 */ | |
| 86 #define cx_szmul(a, b, result) __builtin_umull_overflow(a, b, result) | |
| 87 #endif // __WORDSIZE | |
| 88 | 81 |
| 89 #else // no GNUC or clang bultin | 82 #else // no GNUC or clang bultin |
| 90 | 83 |
| 91 /** | 84 /** |
| 92 * Performs a multiplication of size_t values and checks for overflow. | 85 * Performs a multiplication of size_t values and checks for overflow. |
| 112 * @return zero, if no overflow occurred and the result is correct, non-zero | 105 * @return zero, if no overflow occurred and the result is correct, non-zero |
| 113 * otherwise | 106 * otherwise |
| 114 */ | 107 */ |
| 115 int cx_szmul_impl(size_t a, size_t b, size_t *result); | 108 int cx_szmul_impl(size_t a, size_t b, size_t *result); |
| 116 | 109 |
| 117 #endif | 110 #endif // cx_szmul |
| 111 | |
| 112 | |
| 113 /** | |
| 114 * Reads data from a stream and writes it to another stream. | |
| 115 * | |
| 116 * @param src the source stream | |
| 117 * @param dest the destination stream | |
| 118 * @param rfnc the read function | |
| 119 * @param wfnc the write function | |
| 120 * @param buf a pointer to the copy buffer or \c NULL if a buffer | |
| 121 * shall be implicitly created on the heap | |
| 122 * @param bufsize the size of the copy buffer - if \p buf is \c NULL you can | |
| 123 * set this to zero to let the implementation decide | |
| 124 * @param n the maximum number of bytes that shall be copied. | |
| 125 * If this is larger than \p bufsize, the content is copied over multiple | |
| 126 * iterations. | |
| 127 * @return the total number of bytes copied | |
| 128 */ | |
| 129 __attribute__((__nonnull__(1, 2, 3, 4))) | |
| 130 size_t cx_stream_bncopy( | |
| 131 void *src, | |
| 132 void *dest, | |
| 133 cx_read_func rfnc, | |
| 134 cx_write_func wfnc, | |
| 135 char *buf, | |
| 136 size_t bufsize, | |
| 137 size_t n | |
| 138 ); | |
| 139 | |
| 140 /** | |
| 141 * Reads data from a stream and writes it to another stream. | |
| 142 * | |
| 143 * @param src the source stream | |
| 144 * @param dest the destination stream | |
| 145 * @param rfnc the read function | |
| 146 * @param wfnc the write function | |
| 147 * @param buf a pointer to the copy buffer or \c NULL if a buffer | |
| 148 * shall be implicitly created on the heap | |
| 149 * @param bufsize the size of the copy buffer - if \p buf is \c NULL you can | |
| 150 * set this to zero to let the implementation decide | |
| 151 * @return total number of bytes copied | |
| 152 */ | |
| 153 #define cx_stream_bcopy(src, dest, rfnc, wfnc, buf, bufsize) \ | |
| 154 cx_stream_bncopy(src, dest, rfnc, wfnc, buf, bufsize, SIZE_MAX) | |
| 155 | |
| 156 /** | |
| 157 * Reads data from a stream and writes it to another stream. | |
| 158 * | |
| 159 * The data is temporarily stored in a stack allocated buffer. | |
| 160 * | |
| 161 * @param src the source stream | |
| 162 * @param dest the destination stream | |
| 163 * @param rfnc the read function | |
| 164 * @param wfnc the write function | |
| 165 * @param n the maximum number of bytes that shall be copied. | |
| 166 * @return total number of bytes copied | |
| 167 */ | |
| 168 __attribute__((__nonnull__)) | |
| 169 size_t cx_stream_ncopy( | |
| 170 void *src, | |
| 171 void *dest, | |
| 172 cx_read_func rfnc, | |
| 173 cx_write_func wfnc, | |
| 174 size_t n | |
| 175 ); | |
| 176 | |
| 177 /** | |
| 178 * Reads data from a stream and writes it to another stream. | |
| 179 * | |
| 180 * The data is temporarily stored in a stack allocated buffer. | |
| 181 * | |
| 182 * @param src the source stream | |
| 183 * @param dest the destination stream | |
| 184 * @param rfnc the read function | |
| 185 * @param wfnc the write function | |
| 186 * @param n the maximum number of bytes that shall be copied. | |
| 187 * @return total number of bytes copied | |
| 188 */ | |
| 189 #define cx_stream_copy(src, dest, rfnc, wfnc) \ | |
| 190 cx_stream_ncopy(src, dest, rfnc, wfnc, SIZE_MAX) | |
| 118 | 191 |
| 119 #ifdef __cplusplus | 192 #ifdef __cplusplus |
| 120 } | 193 } |
| 121 #endif | 194 #endif |
| 122 | 195 |
