Sun, 07 Oct 2018 09:00:08 +0200
fixes ucx_szmul definition for gcc < 5
103
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
1 | /* |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
2 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
3 | * |
259 | 4 | * Copyright 2017 Mike Becker, Olaf Wintermann All rights reserved. |
103
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
5 | * |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
6 | * Redistribution and use in source and binary forms, with or without |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
7 | * modification, are permitted provided that the following conditions are met: |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
8 | * |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
9 | * 1. Redistributions of source code must retain the above copyright |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
10 | * notice, this list of conditions and the following disclaimer. |
5
a1740117e2b7
added list specification
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
11 | * |
103
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
12 | * 2. Redistributions in binary form must reproduce the above copyright |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
13 | * notice, this list of conditions and the following disclaimer in the |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
14 | * documentation and/or other materials provided with the distribution. |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
15 | * |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
16 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
17 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
18 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
19 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
20 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
21 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
22 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
23 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
24 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
25 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
93
diff
changeset
|
26 | * POSSIBILITY OF SUCH DAMAGE. |
5
a1740117e2b7
added list specification
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
27 | */ |
114
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
28 | /** |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
29 | * Main UCX Header providing most common definitions. |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
30 | * |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
31 | * @file ucx.h |
115 | 32 | * @author Mike Becker |
114
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
33 | * @author Olaf Wintermann |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
34 | */ |
5
a1740117e2b7
added list specification
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
35 | |
a1740117e2b7
added list specification
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
36 | #ifndef UCX_H |
a1740117e2b7
added list specification
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
37 | #define UCX_H |
a1740117e2b7
added list specification
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
38 | |
151
fc8d05972af7
added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents:
132
diff
changeset
|
39 | /** Major UCX version as integer constant. */ |
306 | 40 | #define UCX_VERSION_MAJOR 2 |
151
fc8d05972af7
added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents:
132
diff
changeset
|
41 | |
fc8d05972af7
added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents:
132
diff
changeset
|
42 | /** Minor UCX version as integer constant. */ |
306 | 43 | #define UCX_VERSION_MINOR 0 |
259 | 44 | |
45 | /** Version constant which ensures to increase monotonically. */ | |
46 | #define UCX_VERSION (((UCX_VERSION_MAJOR)<<16)|UCX_VERSION_MINOR) | |
151
fc8d05972af7
added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents:
132
diff
changeset
|
47 | |
5
a1740117e2b7
added list specification
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
48 | #include <stdlib.h> |
243
2e74828c5e94
adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents:
228
diff
changeset
|
49 | #include <stdint.h> |
5
a1740117e2b7
added list specification
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
50 | |
127
5418bda21896
added ssize_t typedef for windows
Mike Becker <universe@uap-core.de>
parents:
121
diff
changeset
|
51 | #ifdef _WIN32 |
132
c7d7e4eeb76b
fixed ssize_t fix for MinGW
Mike Becker <universe@uap-core.de>
parents:
131
diff
changeset
|
52 | #if !(defined __ssize_t_defined || defined _SSIZE_T_) |
127
5418bda21896
added ssize_t typedef for windows
Mike Becker <universe@uap-core.de>
parents:
121
diff
changeset
|
53 | #include <BaseTsd.h> |
5418bda21896
added ssize_t typedef for windows
Mike Becker <universe@uap-core.de>
parents:
121
diff
changeset
|
54 | typedef SSIZE_T ssize_t; |
5418bda21896
added ssize_t typedef for windows
Mike Becker <universe@uap-core.de>
parents:
121
diff
changeset
|
55 | #define __ssize_t_defined |
132
c7d7e4eeb76b
fixed ssize_t fix for MinGW
Mike Becker <universe@uap-core.de>
parents:
131
diff
changeset
|
56 | #define _SSIZE_T_ |
c7d7e4eeb76b
fixed ssize_t fix for MinGW
Mike Becker <universe@uap-core.de>
parents:
131
diff
changeset
|
57 | #endif /* __ssize_t_defined and _SSIZE_T */ |
127
5418bda21896
added ssize_t typedef for windows
Mike Becker <universe@uap-core.de>
parents:
121
diff
changeset
|
58 | #else /* !_WIN32 */ |
5418bda21896
added ssize_t typedef for windows
Mike Becker <universe@uap-core.de>
parents:
121
diff
changeset
|
59 | #include <sys/types.h> |
5418bda21896
added ssize_t typedef for windows
Mike Becker <universe@uap-core.de>
parents:
121
diff
changeset
|
60 | #endif /* _WIN32 */ |
5418bda21896
added ssize_t typedef for windows
Mike Becker <universe@uap-core.de>
parents:
121
diff
changeset
|
61 | |
5
a1740117e2b7
added list specification
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
62 | #ifdef __cplusplus |
a1740117e2b7
added list specification
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
63 | extern "C" { |
a1740117e2b7
added list specification
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
64 | #endif |
209
4f02199d8aae
moved ucx_destructor type to ucx.h and added destructor argument to ucx_map_free_content
Mike Becker <universe@uap-core.de>
parents:
192
diff
changeset
|
65 | |
4f02199d8aae
moved ucx_destructor type to ucx.h and added destructor argument to ucx_map_free_content
Mike Becker <universe@uap-core.de>
parents:
192
diff
changeset
|
66 | |
4f02199d8aae
moved ucx_destructor type to ucx.h and added destructor argument to ucx_map_free_content
Mike Becker <universe@uap-core.de>
parents:
192
diff
changeset
|
67 | /** |
4f02199d8aae
moved ucx_destructor type to ucx.h and added destructor argument to ucx_map_free_content
Mike Becker <universe@uap-core.de>
parents:
192
diff
changeset
|
68 | * A function pointer to a destructor function. |
4f02199d8aae
moved ucx_destructor type to ucx.h and added destructor argument to ucx_map_free_content
Mike Becker <universe@uap-core.de>
parents:
192
diff
changeset
|
69 | * @see ucx_mempool_setdestr() |
4f02199d8aae
moved ucx_destructor type to ucx.h and added destructor argument to ucx_map_free_content
Mike Becker <universe@uap-core.de>
parents:
192
diff
changeset
|
70 | * @see ucx_mempool_regdestr() |
4f02199d8aae
moved ucx_destructor type to ucx.h and added destructor argument to ucx_map_free_content
Mike Becker <universe@uap-core.de>
parents:
192
diff
changeset
|
71 | */ |
4f02199d8aae
moved ucx_destructor type to ucx.h and added destructor argument to ucx_map_free_content
Mike Becker <universe@uap-core.de>
parents:
192
diff
changeset
|
72 | typedef void(*ucx_destructor)(void*); |
5
a1740117e2b7
added list specification
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
73 | |
114
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
74 | /** |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
75 | * Function pointer to a compare function. |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
76 | * |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
77 | * The compare function shall take three arguments: the two values that shall be |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
78 | * compared and optional additional data. |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
79 | * The function shall then return -1 if the first argument is less than the |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
80 | * second argument, 1 if the first argument is greater than the second argument |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
81 | * and 0 if both arguments are equal. If the third argument is |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
82 | * <code>NULL</code>, it shall be ignored. |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
83 | */ |
244
98dc2d3a9b1d
adds const qualifiers to compare, distance and copy function signatures
Mike Becker <universe@uap-core.de>
parents:
243
diff
changeset
|
84 | typedef int(*cmp_func)(const void*,const void*,void*); |
18
69636f81db31
added clone and equals to lists
Mike Becker <universe@uap-core.de>
parents:
5
diff
changeset
|
85 | |
114
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
86 | /** |
243
2e74828c5e94
adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents:
228
diff
changeset
|
87 | * Function pointer to a distance function. |
2e74828c5e94
adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents:
228
diff
changeset
|
88 | * |
2e74828c5e94
adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents:
228
diff
changeset
|
89 | * The distance function shall take three arguments: the two values for which |
2e74828c5e94
adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents:
228
diff
changeset
|
90 | * the distance shall be computed and optional additional data. |
2e74828c5e94
adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents:
228
diff
changeset
|
91 | * The function shall then return the signed distance as integer value. |
2e74828c5e94
adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents:
228
diff
changeset
|
92 | */ |
244
98dc2d3a9b1d
adds const qualifiers to compare, distance and copy function signatures
Mike Becker <universe@uap-core.de>
parents:
243
diff
changeset
|
93 | typedef intmax_t(*distance_func)(const void*,const void*,void*); |
243
2e74828c5e94
adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents:
228
diff
changeset
|
94 | |
2e74828c5e94
adds distance function and ucx_avl_find_node()
Mike Becker <universe@uap-core.de>
parents:
228
diff
changeset
|
95 | /** |
114
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
96 | * Function pointer to a copy function. |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
97 | * |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
98 | * The copy function shall create a copy of the first argument and may use |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
99 | * additional data provided by the second argument. If the second argument is |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
100 | * <code>NULL</code>, it shall be ignored. |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
101 | |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
102 | * <b>Attention:</b> if pointers returned by functions of this type may be |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
103 | * passed to <code>free()</code> depends on the implementation of the |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
104 | * respective <code>copy_func</code>. |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
105 | */ |
244
98dc2d3a9b1d
adds const qualifiers to compare, distance and copy function signatures
Mike Becker <universe@uap-core.de>
parents:
243
diff
changeset
|
106 | typedef void*(*copy_func)(const void*,void*); |
18
69636f81db31
added clone and equals to lists
Mike Becker <universe@uap-core.de>
parents:
5
diff
changeset
|
107 | |
114
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
108 | /** |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
109 | * Function pointer to a write function. |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
110 | * |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
111 | * The signature of the write function shall be compatible to the signature |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
112 | * of standard <code>fwrite</code>, though it may use arbitrary data types for |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
113 | * source and destination. |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
114 | * |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
115 | * The arguments shall contain (in ascending order): a pointer to the source, |
116
234920008754
some fixes and some documentation
Mike Becker <universe@uap-core.de>
parents:
115
diff
changeset
|
116 | * the length of one element, the element count and a pointer to the |
234920008754
some fixes and some documentation
Mike Becker <universe@uap-core.de>
parents:
115
diff
changeset
|
117 | * destination. |
114
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
118 | */ |
76 | 119 | typedef size_t(*write_func)(const void*, size_t, size_t, void*); |
120 | ||
114
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
121 | /** |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
122 | * Function pointer to a read function. |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
123 | * |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
124 | * The signature of the read function shall be compatible to the signature |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
125 | * of standard <code>fread</code>, though it may use arbitrary data types for |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
126 | * source and destination. |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
127 | * |
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
128 | * The arguments shall contain (in ascending order): a pointer to the |
116
234920008754
some fixes and some documentation
Mike Becker <universe@uap-core.de>
parents:
115
diff
changeset
|
129 | * destination, the length of one element, the element count and a pointer to |
234920008754
some fixes and some documentation
Mike Becker <universe@uap-core.de>
parents:
115
diff
changeset
|
130 | * the source. |
114
5a0859739b76
added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
103
diff
changeset
|
131 | */ |
76 | 132 | typedef size_t(*read_func)(void*, size_t, size_t, void*); |
133 | ||
270
3d80d425543b
adds integer overflow checks
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
259
diff
changeset
|
134 | |
3d80d425543b
adds integer overflow checks
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
259
diff
changeset
|
135 | |
331
3b985a4eb05b
fixes ucx_szmul definition for gcc < 5
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
306
diff
changeset
|
136 | #if __GNUC__ >= 5 || defined(__clang__) |
270
3d80d425543b
adds integer overflow checks
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
259
diff
changeset
|
137 | #define UCX_MUL_BUILTIN |
303
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
138 | |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
139 | #if __WORDSIZE == 32 |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
140 | /** |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
141 | * Alias for <code>__builtin_umul_overflow</code>. |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
142 | * |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
143 | * Performs a multiplication of size_t values and checks for overflow. |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
144 | * |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
145 | * @param a first operand |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
146 | * @param b second operand |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
147 | * @param result a pointer to a size_t, where the result should |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
148 | * be stored |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
149 | * @return zero, if no overflow occurred and the result is correct, non-zero |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
150 | * otherwise |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
151 | */ |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
152 | #define ucx_szmul(a, b, result) __builtin_umul_overflow(a, b, result) |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
153 | #else /* __WORDSIZE != 32 */ |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
154 | /** |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
155 | * Alias for <code>__builtin_umull_overflow</code>. |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
156 | * |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
157 | * Performs a multiplication of size_t values and checks for overflow. |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
158 | * |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
159 | * @param a first operand |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
160 | * @param b second operand |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
161 | * @param result a pointer to a size_t, where the result should |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
162 | * be stored |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
163 | * @return zero, if no overflow occurred and the result is correct, non-zero |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
164 | * otherwise |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
165 | */ |
270
3d80d425543b
adds integer overflow checks
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
259
diff
changeset
|
166 | #define ucx_szmul(a, b, result) __builtin_umull_overflow(a, b, result) |
303
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
167 | #endif /* __WORDSIZE */ |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
168 | |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
169 | #else /* no GNUC or clang bultin */ |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
170 | |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
171 | /** |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
172 | * Performs a multiplication of size_t values and checks for overflow. |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
173 | * |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
174 | * This is a custom implementation in case there is no compiler builtin |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
175 | * available. |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
176 | * |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
177 | * @param a first operand |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
178 | * @param b second operand |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
179 | * @param result a pointer to a size_t, where the result should |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
180 | * be stored |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
181 | * @return zero, if no overflow occurred and the result is correct, non-zero |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
182 | * otherwise |
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
183 | */ |
331
3b985a4eb05b
fixes ucx_szmul definition for gcc < 5
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
306
diff
changeset
|
184 | #define ucx_szmul(a, b, result) ucx_szmul_impl(a, b, result) |
3b985a4eb05b
fixes ucx_szmul definition for gcc < 5
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
306
diff
changeset
|
185 | |
3b985a4eb05b
fixes ucx_szmul definition for gcc < 5
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
306
diff
changeset
|
186 | int ucx_szmul_impl(size_t a, size_t b, size_t *result); |
303
362679052788
adds documentation for ucx_szmul and 32 bit support
Mike Becker <universe@uap-core.de>
parents:
283
diff
changeset
|
187 | |
270
3d80d425543b
adds integer overflow checks
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
259
diff
changeset
|
188 | #endif |
3d80d425543b
adds integer overflow checks
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
259
diff
changeset
|
189 | |
5
a1740117e2b7
added list specification
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
190 | #ifdef __cplusplus |
a1740117e2b7
added list specification
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
191 | } |
a1740117e2b7
added list specification
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
192 | #endif |
a1740117e2b7
added list specification
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
193 | |
a1740117e2b7
added list specification
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
194 | #endif /* UCX_H */ |
a1740117e2b7
added list specification
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
195 |