… | |
… | |
15 | It mainly provides a number of wrappers around GCC built-ins, together |
15 | It mainly provides a number of wrappers around GCC built-ins, together |
16 | with replacement functions for other compilers. In addition to this, |
16 | with replacement functions for other compilers. In addition to this, |
17 | it provides a number of other lowlevel C utilities, such as endianness |
17 | it provides a number of other lowlevel C utilities, such as endianness |
18 | detection, byte swapping or bit rotations. |
18 | detection, byte swapping or bit rotations. |
19 | |
19 | |
20 | Or in other words, things that should be built-in into any standard C |
20 | Or in other words, things that should be built into any standard C system, |
21 | system, but isn't. |
21 | but aren't, implemented as efficient as possible with GCC, and still |
|
|
22 | correct with other compilers. |
22 | |
23 | |
23 | More might come. |
24 | More might come. |
24 | |
25 | |
25 | =head2 ABOUT THE HEADER |
26 | =head2 ABOUT THE HEADER |
26 | |
27 | |
… | |
… | |
53 | only a generic name is used (C<expr>, C<cond>, C<value> and so on), then |
54 | only a generic name is used (C<expr>, C<cond>, C<value> and so on), then |
54 | the corresponding function relies on C to implement the correct types, and |
55 | the corresponding function relies on C to implement the correct types, and |
55 | is usually implemented as a macro. Specifically, a "bool" in this manual |
56 | is usually implemented as a macro. Specifically, a "bool" in this manual |
56 | refers to any kind of boolean value, not a specific type. |
57 | refers to any kind of boolean value, not a specific type. |
57 | |
58 | |
58 | =head2 GCC ATTRIBUTES |
59 | =head2 TYPES / TYPE SUPPORT |
59 | |
60 | |
60 | blabla where to put, what others |
61 | ecb.h makes sure that the following types are defined (in the expected way): |
|
|
62 | |
|
|
63 | int8_t uint8_t int16_t uint16_t |
|
|
64 | int32_t uint32_t int64_t uint64_t |
|
|
65 | intptr_t uintptr_t |
|
|
66 | |
|
|
67 | The macro C<ECB_PTRSIZE> is defined to the size of a pointer on this |
|
|
68 | platform (currently C<4> or C<8>) and can be used in preprocessor |
|
|
69 | expressions. |
|
|
70 | |
|
|
71 | For C<ptrdiff_t> and C<size_t> use C<stddef.h>. |
|
|
72 | |
|
|
73 | =head2 LANGUAGE/ENVIRONMENT/COMPILER VERSIONS |
|
|
74 | |
|
|
75 | All the following symbols expand to an expression that can be tested in |
|
|
76 | preprocessor instructions as well as treated as a boolean (use C<!!> to |
|
|
77 | ensure it's either C<0> or C<1> if you need that). |
61 | |
78 | |
62 | =over 4 |
79 | =over 4 |
63 | |
80 | |
64 | =item ecb_attribute ((attrs...)) |
81 | =item ECB_C |
65 | |
82 | |
66 | A simple wrapper that expands to C<__attribute__((attrs))> on GCC, and to |
83 | True if the implementation defines the C<__STDC__> macro to a true value, |
67 | nothing on other compilers, so the effect is that only GCC sees these. |
84 | while not claiming to be C++. |
68 | |
85 | |
69 | Example: use the C<deprecated> attribute on a function. |
86 | =item ECB_C99 |
70 | |
87 | |
71 | ecb_attribute((__deprecated__)) void |
88 | True if the implementation claims to be compliant to C99 (ISO/IEC |
72 | do_not_use_me_anymore (void); |
89 | 9899:1999) or any later version, while not claiming to be C++. |
|
|
90 | |
|
|
91 | Note that later versions (ECB_C11) remove core features again (for |
|
|
92 | example, variable length arrays). |
|
|
93 | |
|
|
94 | =item ECB_C11 |
|
|
95 | |
|
|
96 | True if the implementation claims to be compliant to C11 (ISO/IEC |
|
|
97 | 9899:2011) or any later version, while not claiming to be C++. |
|
|
98 | |
|
|
99 | =item ECB_CPP |
|
|
100 | |
|
|
101 | True if the implementation defines the C<__cplusplus__> macro to a true |
|
|
102 | value, which is typically true for C++ compilers. |
|
|
103 | |
|
|
104 | =item ECB_CPP11 |
|
|
105 | |
|
|
106 | True if the implementation claims to be compliant to ISO/IEC 14882:2011 |
|
|
107 | (C++11) or any later version. |
|
|
108 | |
|
|
109 | =item ECB_GCC_VERSION (major, minor) |
|
|
110 | |
|
|
111 | Expands to a true value (suitable for testing in by the preprocessor) |
|
|
112 | if the compiler used is GNU C and the version is the given version, or |
|
|
113 | higher. |
|
|
114 | |
|
|
115 | This macro tries to return false on compilers that claim to be GCC |
|
|
116 | compatible but aren't. |
|
|
117 | |
|
|
118 | =item ECB_EXTERN_C |
|
|
119 | |
|
|
120 | Expands to C<extern "C"> in C++, and a simple C<extern> in C. |
|
|
121 | |
|
|
122 | This can be used to declare a single external C function: |
|
|
123 | |
|
|
124 | ECB_EXTERN_C int printf (const char *format, ...); |
|
|
125 | |
|
|
126 | =item ECB_EXTERN_C_BEG / ECB_EXTERN_C_END |
|
|
127 | |
|
|
128 | These two macros can be used to wrap multiple C<extern "C"> definitions - |
|
|
129 | they expand to nothing in C. |
|
|
130 | |
|
|
131 | They are most useful in header files: |
|
|
132 | |
|
|
133 | ECB_EXTERN_C_BEG |
|
|
134 | |
|
|
135 | int mycfun1 (int x); |
|
|
136 | int mycfun2 (int x); |
|
|
137 | |
|
|
138 | ECB_EXTERN_C_END |
|
|
139 | |
|
|
140 | =item ECB_STDFP |
|
|
141 | |
|
|
142 | If this evaluates to a true value (suitable for testing in by the |
|
|
143 | preprocessor), then C<float> and C<double> use IEEE 754 single/binary32 |
|
|
144 | and double/binary64 representations internally I<and> the endianness of |
|
|
145 | both types match the endianness of C<uint32_t> and C<uint64_t>. |
|
|
146 | |
|
|
147 | This means you can just copy the bits of a C<float> (or C<double>) to an |
|
|
148 | C<uint32_t> (or C<uint64_t>) and get the raw IEEE 754 bit representation |
|
|
149 | without having to think about format or endianness. |
|
|
150 | |
|
|
151 | This is true for basically all modern platforms, although F<ecb.h> might |
|
|
152 | not be able to deduce this correctly everywhere and might err on the safe |
|
|
153 | side. |
|
|
154 | |
|
|
155 | =item ECB_AMD64, ECB_AMD64_X32 |
|
|
156 | |
|
|
157 | These two macros are defined to C<1> on the x86_64/amd64 ABI and the X32 |
|
|
158 | ABI, respectively, and undefined elsewhere. |
|
|
159 | |
|
|
160 | The designers of the new X32 ABI for some inexplicable reason decided to |
|
|
161 | make it look exactly like amd64, even though it's completely incompatible |
|
|
162 | to that ABI, breaking about every piece of software that assumed that |
|
|
163 | C<__x86_64> stands for, well, the x86-64 ABI, making these macros |
|
|
164 | necessary. |
|
|
165 | |
|
|
166 | =back |
|
|
167 | |
|
|
168 | =head2 MACRO TRICKERY |
|
|
169 | |
|
|
170 | =over 4 |
|
|
171 | |
|
|
172 | =item ECB_CONCAT (a, b) |
|
|
173 | |
|
|
174 | Expands any macros in C<a> and C<b>, then concatenates the result to form |
|
|
175 | a single token. This is mainly useful to form identifiers from components, |
|
|
176 | e.g.: |
|
|
177 | |
|
|
178 | #define S1 str |
|
|
179 | #define S2 cpy |
|
|
180 | |
|
|
181 | ECB_CONCAT (S1, S2)(dst, src); // == strcpy (dst, src); |
|
|
182 | |
|
|
183 | =item ECB_STRINGIFY (arg) |
|
|
184 | |
|
|
185 | Expands any macros in C<arg> and returns the stringified version of |
|
|
186 | it. This is mainly useful to get the contents of a macro in string form, |
|
|
187 | e.g.: |
|
|
188 | |
|
|
189 | #define SQL_LIMIT 100 |
|
|
190 | sql_exec ("select * from table limit " ECB_STRINGIFY (SQL_LIMIT)); |
|
|
191 | |
|
|
192 | =back |
|
|
193 | |
|
|
194 | =head2 ATTRIBUTES |
|
|
195 | |
|
|
196 | A major part of libecb deals with additional attributes that can be |
|
|
197 | assigned to functions, variables and sometimes even types - much like |
|
|
198 | C<const> or C<volatile> in C. They are implemented using either GCC |
|
|
199 | attributes or other compiler/language specific features. Attributes |
|
|
200 | declarations must be put before the whole declaration: |
|
|
201 | |
|
|
202 | ecb_const int mysqrt (int a); |
|
|
203 | ecb_unused int i; |
|
|
204 | |
|
|
205 | =over 4 |
73 | |
206 | |
74 | =item ecb_unused |
207 | =item ecb_unused |
75 | |
208 | |
76 | Marks a function or a variable as "unused", which simply suppresses a |
209 | Marks a function or a variable as "unused", which simply suppresses a |
77 | warning by GCC when it detects it as unused. This is useful when you e.g. |
210 | warning by GCC when it detects it as unused. This is useful when you e.g. |
78 | declare a variable but do not always use it: |
211 | declare a variable but do not always use it: |
79 | |
212 | |
80 | { |
213 | { |
81 | int var ecb_unused; |
214 | ecb_unused int var; |
82 | |
215 | |
83 | #ifdef SOMECONDITION |
216 | #ifdef SOMECONDITION |
84 | var = ...; |
217 | var = ...; |
85 | return var; |
218 | return var; |
86 | #else |
219 | #else |
87 | return 0; |
220 | return 0; |
88 | #endif |
221 | #endif |
89 | } |
222 | } |
90 | |
223 | |
|
|
224 | =item ecb_deprecated |
|
|
225 | |
|
|
226 | Similar to C<ecb_unused>, but marks a function, variable or type as |
|
|
227 | deprecated. This makes some compilers warn when the type is used. |
|
|
228 | |
|
|
229 | =item ecb_deprecated_message (message) |
|
|
230 | |
|
|
231 | Same as C<ecb_deprecated>, but if possible, supply a diagnostic that is |
|
|
232 | used instead of a generic depreciation message when the object is being |
|
|
233 | used. |
|
|
234 | |
|
|
235 | =item ecb_inline |
|
|
236 | |
|
|
237 | Expands either to C<static inline> or to just C<static>, if inline |
|
|
238 | isn't supported. It should be used to declare functions that should be |
|
|
239 | inlined, for code size or speed reasons. |
|
|
240 | |
|
|
241 | Example: inline this function, it surely will reduce codesize. |
|
|
242 | |
|
|
243 | ecb_inline int |
|
|
244 | negmul (int a, int b) |
|
|
245 | { |
|
|
246 | return - (a * b); |
|
|
247 | } |
|
|
248 | |
91 | =item ecb_noinline |
249 | =item ecb_noinline |
92 | |
250 | |
93 | Prevent a function from being inlined - it might be optimised away, but |
251 | Prevent a function from being inlined - it might be optimised away, but |
94 | not inlined into other functions. This is useful if you know your function |
252 | not inlined into other functions. This is useful if you know your function |
95 | is rarely called and large enough for inlining not to be helpful. |
253 | is rarely called and large enough for inlining not to be helpful. |
… | |
… | |
105 | { |
263 | { |
106 | puts (errline); |
264 | puts (errline); |
107 | abort (); |
265 | abort (); |
108 | } |
266 | } |
109 | |
267 | |
110 | In this case, the compiler would probbaly be smart enough to decude it on |
268 | In this case, the compiler would probably be smart enough to deduce it on |
111 | it's own, so this is mainly useful for declarations. |
269 | its own, so this is mainly useful for declarations. |
|
|
270 | |
|
|
271 | =item ecb_restrict |
|
|
272 | |
|
|
273 | Expands to the C<restrict> keyword or equivalent on compilers that support |
|
|
274 | them, and to nothing on others. Must be specified on a pointer type or |
|
|
275 | an array index to indicate that the memory doesn't alias with any other |
|
|
276 | restricted pointer in the same scope. |
|
|
277 | |
|
|
278 | Example: multiply a vector, and allow the compiler to parallelise the |
|
|
279 | loop, because it knows it doesn't overwrite input values. |
|
|
280 | |
|
|
281 | void |
|
|
282 | multiply (ecb_restrict float *src, |
|
|
283 | ecb_restrict float *dst, |
|
|
284 | int len, float factor) |
|
|
285 | { |
|
|
286 | int i; |
|
|
287 | |
|
|
288 | for (i = 0; i < len; ++i) |
|
|
289 | dst [i] = src [i] * factor; |
|
|
290 | } |
112 | |
291 | |
113 | =item ecb_const |
292 | =item ecb_const |
114 | |
293 | |
115 | Declares that the function only depends on the values of it's arguments, |
294 | Declares that the function only depends on the values of its arguments, |
116 | much like a mathematical function. It specifically does not read or write |
295 | much like a mathematical function. It specifically does not read or write |
117 | any memory any arguments might point to, global variables, or call any |
296 | any memory any arguments might point to, global variables, or call any |
118 | non-const functions. It also must not have any side effects. |
297 | non-const functions. It also must not have any side effects. |
119 | |
298 | |
120 | Such a function can be optimised much more aggressively by the compiler - |
299 | Such a function can be optimised much more aggressively by the compiler - |
121 | for example, multiple calls with the same arguments can be optimised into |
300 | for example, multiple calls with the same arguments can be optimised into |
122 | a single call, which wouldn't be possible if the compiler would have to |
301 | a single call, which wouldn't be possible if the compiler would have to |
123 | expect any side effects. |
302 | expect any side effects. |
124 | |
303 | |
125 | It is best suited for functions in the sense of mathematical functions, |
304 | It is best suited for functions in the sense of mathematical functions, |
126 | such as a function return the square root of its input argument. |
305 | such as a function returning the square root of its input argument. |
127 | |
306 | |
128 | Not suited would be a function that calculates the hash of some memory |
307 | Not suited would be a function that calculates the hash of some memory |
129 | area you pass in, prints some messages or looks at a global variable to |
308 | area you pass in, prints some messages or looks at a global variable to |
130 | decide on rounding. |
309 | decide on rounding. |
131 | |
310 | |
… | |
… | |
154 | possible. |
333 | possible. |
155 | |
334 | |
156 | The compiler reacts by trying to place hot functions near to each other in |
335 | The compiler reacts by trying to place hot functions near to each other in |
157 | memory. |
336 | memory. |
158 | |
337 | |
159 | Whether a function is hot or not often depend son the whole program, |
338 | Whether a function is hot or not often depends on the whole program, |
160 | and less on the function itself. C<ecb_cold> is likely more useful in |
339 | and less on the function itself. C<ecb_cold> is likely more useful in |
161 | practise. |
340 | practise. |
162 | |
341 | |
163 | =item ecb_cold |
342 | =item ecb_cold |
164 | |
343 | |
… | |
… | |
169 | |
348 | |
170 | In addition to placing cold functions together (or at least away from hot |
349 | In addition to placing cold functions together (or at least away from hot |
171 | functions), this knowledge can be used in other ways, for example, the |
350 | functions), this knowledge can be used in other ways, for example, the |
172 | function will be optimised for size, as opposed to speed, and codepaths |
351 | function will be optimised for size, as opposed to speed, and codepaths |
173 | leading to calls to those functions can automatically be marked as if |
352 | leading to calls to those functions can automatically be marked as if |
174 | C<ecb_unlikel> had been used to reach them. |
353 | C<ecb_expect_false> had been used to reach them. |
175 | |
354 | |
176 | Good examples for such functions would be error reporting functions, or |
355 | Good examples for such functions would be error reporting functions, or |
177 | functions only called in exceptional or rare cases. |
356 | functions only called in exceptional or rare cases. |
178 | |
357 | |
179 | =item ecb_artificial |
358 | =item ecb_artificial |
180 | |
359 | |
181 | Declares the function as "artificial", in this case meaning that this |
360 | Declares the function as "artificial", in this case meaning that this |
182 | function is not really mean to be a function, but more like an accessor |
361 | function is not really meant to be a function, but more like an accessor |
183 | - many methods in C++ classes are mere accessor functions, and having a |
362 | - many methods in C++ classes are mere accessor functions, and having a |
184 | crash reported in such a method, or single-stepping through them, is not |
363 | crash reported in such a method, or single-stepping through them, is not |
185 | usually so helpful, especially when it's inlined to just a few instructions. |
364 | usually so helpful, especially when it's inlined to just a few instructions. |
186 | |
365 | |
187 | Marking them as artificial will instruct the debugger about just this, |
366 | Marking them as artificial will instruct the debugger about just this, |
… | |
… | |
207 | |
386 | |
208 | =head2 OPTIMISATION HINTS |
387 | =head2 OPTIMISATION HINTS |
209 | |
388 | |
210 | =over 4 |
389 | =over 4 |
211 | |
390 | |
212 | =item bool ecb_is_constant(expr) |
391 | =item bool ecb_is_constant (expr) |
213 | |
392 | |
214 | Returns true iff the expression can be deduced to be a compile-time |
393 | Returns true iff the expression can be deduced to be a compile-time |
215 | constant, and false otherwise. |
394 | constant, and false otherwise. |
216 | |
395 | |
217 | For example, when you have a C<rndm16> function that returns a 16 bit |
396 | For example, when you have a C<rndm16> function that returns a 16 bit |
… | |
… | |
235 | return is_constant (n) && !(n & (n - 1)) |
414 | return is_constant (n) && !(n & (n - 1)) |
236 | ? rndm16 () & (num - 1) |
415 | ? rndm16 () & (num - 1) |
237 | : (n * (uint32_t)rndm16 ()) >> 16; |
416 | : (n * (uint32_t)rndm16 ()) >> 16; |
238 | } |
417 | } |
239 | |
418 | |
240 | =item bool ecb_expect (expr, value) |
419 | =item ecb_expect (expr, value) |
241 | |
420 | |
242 | Evaluates C<expr> and returns it. In addition, it tells the compiler that |
421 | Evaluates C<expr> and returns it. In addition, it tells the compiler that |
243 | the C<expr> evaluates to C<value> a lot, which can be used for static |
422 | the C<expr> evaluates to C<value> a lot, which can be used for static |
244 | branch optimisations. |
423 | branch optimisations. |
245 | |
424 | |
246 | Usually, you want to use the more intuitive C<ecb_likely> and |
425 | Usually, you want to use the more intuitive C<ecb_expect_true> and |
247 | C<ecb_unlikely> functions instead. |
426 | C<ecb_expect_false> functions instead. |
248 | |
427 | |
|
|
428 | =item bool ecb_expect_true (cond) |
|
|
429 | |
249 | =item bool ecb_likely (cond) |
430 | =item bool ecb_expect_false (cond) |
250 | |
|
|
251 | =item bool ecb_unlikely (cond) |
|
|
252 | |
431 | |
253 | These two functions expect a expression that is true or false and return |
432 | These two functions expect a expression that is true or false and return |
254 | C<1> or C<0>, respectively, so when used in the condition of an C<if> or |
433 | C<1> or C<0>, respectively, so when used in the condition of an C<if> or |
255 | other conditional statement, it will not change the program: |
434 | other conditional statement, it will not change the program: |
256 | |
435 | |
257 | /* these two do the same thing */ |
436 | /* these two do the same thing */ |
258 | if (some_condition) ...; |
437 | if (some_condition) ...; |
259 | if (ecb_likely (some_condition)) ...; |
438 | if (ecb_expect_true (some_condition)) ...; |
260 | |
439 | |
261 | However, by using C<ecb_likely>, you tell the compiler that the condition |
440 | However, by using C<ecb_expect_true>, you tell the compiler that the |
262 | is likely to be true (and for C<ecb_unlikely>, that it is unlikely to be |
441 | condition is likely to be true (and for C<ecb_expect_false>, that it is |
263 | true). |
442 | unlikely to be true). |
264 | |
443 | |
265 | For example, when you check for a null pointer and expect this to be a |
444 | For example, when you check for a null pointer and expect this to be a |
266 | rare, exceptional, case, then use C<ecb_unlikely>: |
445 | rare, exceptional, case, then use C<ecb_expect_false>: |
267 | |
446 | |
268 | void my_free (void *ptr) |
447 | void my_free (void *ptr) |
269 | { |
448 | { |
270 | if (ecb_unlikely (ptr == 0)) |
449 | if (ecb_expect_false (ptr == 0)) |
271 | return; |
450 | return; |
272 | } |
451 | } |
273 | |
452 | |
274 | Consequent use of these functions to mark away exceptional cases or to |
453 | Consequent use of these functions to mark away exceptional cases or to |
275 | tell the compiler what the hot path through a function is can increase |
454 | tell the compiler what the hot path through a function is can increase |
276 | performance considerably. |
455 | performance considerably. |
|
|
456 | |
|
|
457 | You might know these functions under the name C<likely> and C<unlikely> |
|
|
458 | - while these are common aliases, we find that the expect name is easier |
|
|
459 | to understand when quickly skimming code. If you wish, you can use |
|
|
460 | C<ecb_likely> instead of C<ecb_expect_true> and C<ecb_unlikely> instead of |
|
|
461 | C<ecb_expect_false> - these are simply aliases. |
277 | |
462 | |
278 | A very good example is in a function that reserves more space for some |
463 | A very good example is in a function that reserves more space for some |
279 | memory block (for example, inside an implementation of a string stream) - |
464 | memory block (for example, inside an implementation of a string stream) - |
280 | each time something is added, you have to check for a buffer overrun, but |
465 | each time something is added, you have to check for a buffer overrun, but |
281 | you expect that most checks will turn out to be false: |
466 | you expect that most checks will turn out to be false: |
282 | |
467 | |
283 | /* make sure we have "size" extra room in our buffer */ |
468 | /* make sure we have "size" extra room in our buffer */ |
284 | ecb_inline void |
469 | ecb_inline void |
285 | reserve (int size) |
470 | reserve (int size) |
286 | { |
471 | { |
287 | if (ecb_unlikely (current + size > end)) |
472 | if (ecb_expect_false (current + size > end)) |
288 | real_reserve_method (size); /* presumably noinline */ |
473 | real_reserve_method (size); /* presumably noinline */ |
289 | } |
474 | } |
290 | |
475 | |
291 | =item bool ecb_assume (cond) |
476 | =item ecb_assume (cond) |
292 | |
477 | |
293 | Try to tell the compiler that some condition is true, even if it's not |
478 | Try to tell the compiler that some condition is true, even if it's not |
294 | obvious. |
479 | obvious. |
295 | |
480 | |
296 | This can be used to teach the compiler about invariants or other |
481 | This can be used to teach the compiler about invariants or other |
297 | conditions that might improve code generation, but which are impossible to |
482 | conditions that might improve code generation, but which are impossible to |
298 | deduce form the code itself. |
483 | deduce form the code itself. |
299 | |
484 | |
300 | For example, the example reservation function from the C<ecb_unlikely> |
485 | For example, the example reservation function from the C<ecb_expect_false> |
301 | description could be written thus (only C<ecb_assume> was added): |
486 | description could be written thus (only C<ecb_assume> was added): |
302 | |
487 | |
303 | ecb_inline void |
488 | ecb_inline void |
304 | reserve (int size) |
489 | reserve (int size) |
305 | { |
490 | { |
306 | if (ecb_unlikely (current + size > end)) |
491 | if (ecb_expect_false (current + size > end)) |
307 | real_reserve_method (size); /* presumably noinline */ |
492 | real_reserve_method (size); /* presumably noinline */ |
308 | |
493 | |
309 | ecb_assume (current + size <= end); |
494 | ecb_assume (current + size <= end); |
310 | } |
495 | } |
311 | |
496 | |
… | |
… | |
316 | |
501 | |
317 | Then the compiler I<might> be able to optimise out the second call |
502 | Then the compiler I<might> be able to optimise out the second call |
318 | completely, as it knows that C<< current + 1 > end >> is false and the |
503 | completely, as it knows that C<< current + 1 > end >> is false and the |
319 | call will never be executed. |
504 | call will never be executed. |
320 | |
505 | |
321 | =item bool ecb_unreachable () |
506 | =item ecb_unreachable () |
322 | |
507 | |
323 | This function does nothing itself, except tell the compiler that it will |
508 | This function does nothing itself, except tell the compiler that it will |
324 | never be executed. Apart from suppressing a warning in some cases, this |
509 | never be executed. Apart from suppressing a warning in some cases, this |
325 | function can be used to implement C<ecb_assume> or similar functions. |
510 | function can be used to implement C<ecb_assume> or similar functions. |
326 | |
511 | |
327 | =item bool ecb_prefetch (addr, rw, locality) |
512 | =item ecb_prefetch (addr, rw, locality) |
328 | |
513 | |
329 | Tells the compiler to try to prefetch memory at the given C<addr>ess |
514 | Tells the compiler to try to prefetch memory at the given C<addr>ess |
330 | for either reading (C<rw> = 0) or writing (C<rw> = 1). A C<locality> of |
515 | for either reading (C<rw> = 0) or writing (C<rw> = 1). A C<locality> of |
331 | C<0> means that there will only be one access later, C<3> means that |
516 | C<0> means that there will only be one access later, C<3> means that |
332 | the data will likely be accessed very often, and values in between mean |
517 | the data will likely be accessed very often, and values in between mean |
… | |
… | |
360 | After processing the node, (part of) the next node might already be in |
545 | After processing the node, (part of) the next node might already be in |
361 | cache. |
546 | cache. |
362 | |
547 | |
363 | =back |
548 | =back |
364 | |
549 | |
365 | =head2 BIT FIDDLING / BITSTUFFS |
550 | =head2 BIT FIDDLING / BIT WIZARDRY |
366 | |
551 | |
367 | =over 4 |
552 | =over 4 |
368 | |
553 | |
369 | =item bool ecb_big_endian () |
554 | =item bool ecb_big_endian () |
370 | |
555 | |
… | |
… | |
372 | |
557 | |
373 | These two functions return true if the byte order is big endian |
558 | These two functions return true if the byte order is big endian |
374 | (most-significant byte first) or little endian (least-significant byte |
559 | (most-significant byte first) or little endian (least-significant byte |
375 | first) respectively. |
560 | first) respectively. |
376 | |
561 | |
|
|
562 | On systems that are neither, their return values are unspecified. |
|
|
563 | |
377 | =item int ecb_ctz32 (uint32_t x) |
564 | =item int ecb_ctz32 (uint32_t x) |
378 | |
565 | |
|
|
566 | =item int ecb_ctz64 (uint64_t x) |
|
|
567 | |
379 | Returns the index of the least significant bit set in C<x> (or |
568 | Returns the index of the least significant bit set in C<x> (or |
380 | equivalently the number of bits set to 0 before the least significant |
569 | equivalently the number of bits set to 0 before the least significant bit |
381 | bit set), starting from 0. If C<x> is 0 the result is undefined. A |
570 | set), starting from 0. If C<x> is 0 the result is undefined. |
382 | common use case is to compute the integer binary logarithm, i.e., |
571 | |
383 | floor(log2(n)). For example: |
572 | For smaller types than C<uint32_t> you can safely use C<ecb_ctz32>. |
|
|
573 | |
|
|
574 | For example: |
384 | |
575 | |
385 | ecb_ctz32 (3) = 0 |
576 | ecb_ctz32 (3) = 0 |
386 | ecb_ctz32 (6) = 1 |
577 | ecb_ctz32 (6) = 1 |
387 | |
578 | |
|
|
579 | =item bool ecb_is_pot32 (uint32_t x) |
|
|
580 | |
|
|
581 | =item bool ecb_is_pot64 (uint32_t x) |
|
|
582 | |
|
|
583 | Return true iff C<x> is a power of two or C<x == 0>. |
|
|
584 | |
|
|
585 | For smaller types then C<uint32_t> you can safely use C<ecb_is_pot32>. |
|
|
586 | |
|
|
587 | =item int ecb_ld32 (uint32_t x) |
|
|
588 | |
|
|
589 | =item int ecb_ld64 (uint64_t x) |
|
|
590 | |
|
|
591 | Returns the index of the most significant bit set in C<x>, or the number |
|
|
592 | of digits the number requires in binary (so that C<< 2**ld <= x < |
|
|
593 | 2**(ld+1) >>). If C<x> is 0 the result is undefined. A common use case is |
|
|
594 | to compute the integer binary logarithm, i.e. C<floor (log2 (n))>, for |
|
|
595 | example to see how many bits a certain number requires to be encoded. |
|
|
596 | |
|
|
597 | This function is similar to the "count leading zero bits" function, except |
|
|
598 | that that one returns how many zero bits are "in front" of the number (in |
|
|
599 | the given data type), while C<ecb_ld> returns how many bits the number |
|
|
600 | itself requires. |
|
|
601 | |
|
|
602 | For smaller types than C<uint32_t> you can safely use C<ecb_ld32>. |
|
|
603 | |
388 | =item int ecb_popcount32 (uint32_t x) |
604 | =item int ecb_popcount32 (uint32_t x) |
389 | |
605 | |
|
|
606 | =item int ecb_popcount64 (uint64_t x) |
|
|
607 | |
390 | Returns the number of bits set to 1 in C<x>. For example: |
608 | Returns the number of bits set to 1 in C<x>. |
|
|
609 | |
|
|
610 | For smaller types than C<uint32_t> you can safely use C<ecb_popcount32>. |
|
|
611 | |
|
|
612 | For example: |
391 | |
613 | |
392 | ecb_popcount32 (7) = 3 |
614 | ecb_popcount32 (7) = 3 |
393 | ecb_popcount32 (255) = 8 |
615 | ecb_popcount32 (255) = 8 |
394 | |
616 | |
|
|
617 | =item uint8_t ecb_bitrev8 (uint8_t x) |
|
|
618 | |
|
|
619 | =item uint16_t ecb_bitrev16 (uint16_t x) |
|
|
620 | |
|
|
621 | =item uint32_t ecb_bitrev32 (uint32_t x) |
|
|
622 | |
|
|
623 | Reverses the bits in x, i.e. the MSB becomes the LSB, MSB-1 becomes LSB+1 |
|
|
624 | and so on. |
|
|
625 | |
|
|
626 | Example: |
|
|
627 | |
|
|
628 | ecb_bitrev8 (0xa7) = 0xea |
|
|
629 | ecb_bitrev32 (0xffcc4411) = 0x882233ff |
|
|
630 | |
395 | =item uint32_t ecb_bswap16 (uint32_t x) |
631 | =item uint32_t ecb_bswap16 (uint32_t x) |
396 | |
632 | |
397 | =item uint32_t ecb_bswap32 (uint32_t x) |
633 | =item uint32_t ecb_bswap32 (uint32_t x) |
398 | |
634 | |
|
|
635 | =item uint64_t ecb_bswap64 (uint64_t x) |
|
|
636 | |
399 | These two functions return the value of the 16-bit (32-bit) variable |
637 | These functions return the value of the 16-bit (32-bit, 64-bit) value |
400 | C<x> after reversing the order of bytes. |
638 | C<x> after reversing the order of bytes (0x11223344 becomes 0x44332211 in |
|
|
639 | C<ecb_bswap32>). |
|
|
640 | |
|
|
641 | =item uint8_t ecb_rotl8 (uint8_t x, unsigned int count) |
|
|
642 | |
|
|
643 | =item uint16_t ecb_rotl16 (uint16_t x, unsigned int count) |
|
|
644 | |
|
|
645 | =item uint32_t ecb_rotl32 (uint32_t x, unsigned int count) |
|
|
646 | |
|
|
647 | =item uint64_t ecb_rotl64 (uint64_t x, unsigned int count) |
|
|
648 | |
|
|
649 | =item uint8_t ecb_rotr8 (uint8_t x, unsigned int count) |
|
|
650 | |
|
|
651 | =item uint16_t ecb_rotr16 (uint16_t x, unsigned int count) |
401 | |
652 | |
402 | =item uint32_t ecb_rotr32 (uint32_t x, unsigned int count) |
653 | =item uint32_t ecb_rotr32 (uint32_t x, unsigned int count) |
403 | |
654 | |
404 | =item uint32_t ecb_rotl32 (uint32_t x, unsigned int count) |
655 | =item uint64_t ecb_rotr64 (uint64_t x, unsigned int count) |
405 | |
656 | |
406 | These two functions return the value of C<x> after shifting all the bits |
657 | These two families of functions return the value of C<x> after rotating |
407 | by C<count> positions to the right or left respectively. |
658 | all the bits by C<count> positions to the right (C<ecb_rotr>) or left |
|
|
659 | (C<ecb_rotl>). |
|
|
660 | |
|
|
661 | Current GCC versions understand these functions and usually compile them |
|
|
662 | to "optimal" code (e.g. a single C<rol> or a combination of C<shld> on |
|
|
663 | x86). |
408 | |
664 | |
409 | =back |
665 | =back |
410 | |
666 | |
|
|
667 | =head2 FLOATING POINT FIDDLING |
|
|
668 | |
|
|
669 | =over 4 |
|
|
670 | |
|
|
671 | =item ECB_INFINITY |
|
|
672 | |
|
|
673 | Evaluates to positive infinity if supported by the platform, otherwise to |
|
|
674 | a truly huge number. |
|
|
675 | |
|
|
676 | =item ECB_NON |
|
|
677 | |
|
|
678 | Evaluates to a quiet NAN if supported by the platform, otherwise to |
|
|
679 | C<ECB_INFINITY>. |
|
|
680 | |
|
|
681 | =item float ecb_ldexpf (float x, int exp) |
|
|
682 | |
|
|
683 | Same as C<ldexpf>, but always available. |
|
|
684 | |
|
|
685 | =item uint32_t ecb_float_to_binary32 (float x) [-UECB_NO_LIBM] |
|
|
686 | |
|
|
687 | =item uint64_t ecb_double_to_binary64 (double x) [-UECB_NO_LIBM] |
|
|
688 | |
|
|
689 | These functions each take an argument in the native C<float> or C<double> |
|
|
690 | type and return the IEEE 754 bit representation of it. |
|
|
691 | |
|
|
692 | The bit representation is just as IEEE 754 defines it, i.e. the sign bit |
|
|
693 | will be the most significant bit, followed by exponent and mantissa. |
|
|
694 | |
|
|
695 | This function should work even when the native floating point format isn't |
|
|
696 | IEEE compliant, of course at a speed and code size penalty, and of course |
|
|
697 | also within reasonable limits (it tries to convert NaNs, infinities and |
|
|
698 | denormals, but will likely convert negative zero to positive zero). |
|
|
699 | |
|
|
700 | On all modern platforms (where C<ECB_STDFP> is true), the compiler should |
|
|
701 | be able to optimise away this function completely. |
|
|
702 | |
|
|
703 | These functions can be helpful when serialising floats to the network - you |
|
|
704 | can serialise the return value like a normal uint32_t/uint64_t. |
|
|
705 | |
|
|
706 | Another use for these functions is to manipulate floating point values |
|
|
707 | directly. |
|
|
708 | |
|
|
709 | Silly example: toggle the sign bit of a float. |
|
|
710 | |
|
|
711 | /* On gcc-4.7 on amd64, */ |
|
|
712 | /* this results in a single add instruction to toggle the bit, and 4 extra */ |
|
|
713 | /* instructions to move the float value to an integer register and back. */ |
|
|
714 | |
|
|
715 | x = ecb_binary32_to_float (ecb_float_to_binary32 (x) ^ 0x80000000U) |
|
|
716 | |
|
|
717 | =item float ecb_binary16_to_float (uint16_t x) [-UECB_NO_LIBM] |
|
|
718 | |
|
|
719 | =item float ecb_binary32_to_float (uint32_t x) [-UECB_NO_LIBM] |
|
|
720 | |
|
|
721 | =item double ecb_binary32_to_double (uint64_t x) [-UECB_NO_LIBM] |
|
|
722 | |
|
|
723 | The reverse operation of the previous function - takes the bit |
|
|
724 | representation of an IEEE binary16, binary32 or binary64 number and |
|
|
725 | converts it to the native C<float> or C<double> format. |
|
|
726 | |
|
|
727 | This function should work even when the native floating point format isn't |
|
|
728 | IEEE compliant, of course at a speed and code size penalty, and of course |
|
|
729 | also within reasonable limits (it tries to convert normals and denormals, |
|
|
730 | and might be lucky for infinities, and with extraordinary luck, also for |
|
|
731 | negative zero). |
|
|
732 | |
|
|
733 | On all modern platforms (where C<ECB_STDFP> is true), the compiler should |
|
|
734 | be able to optimise away this function completely. |
|
|
735 | |
|
|
736 | =back |
|
|
737 | |
411 | =head2 ARITHMETIC |
738 | =head2 ARITHMETIC |
412 | |
739 | |
413 | =over 4 |
740 | =over 4 |
414 | |
741 | |
415 | =item x = ecb_mod (m, n) |
742 | =item x = ecb_mod (m, n) |
416 | |
743 | |
417 | Returns the positive remainder of the modulo operation between C<m> and |
744 | Returns C<m> modulo C<n>, which is the same as the positive remainder |
|
|
745 | of the division operation between C<m> and C<n>, using floored |
418 | C<n>. Unlike the C modulo operator C<%>, this function ensures that the |
746 | division. Unlike the C remainder operator C<%>, this function ensures that |
419 | return value is always positive). |
747 | the return value is always positive and that the two numbers I<m> and |
|
|
748 | I<m' = m + i * n> result in the same value modulo I<n> - in other words, |
|
|
749 | C<ecb_mod> implements the mathematical modulo operation, which is missing |
|
|
750 | in the language. |
420 | |
751 | |
421 | C<n> must be strictly positive (i.e. C<< >1 >>), while C<m> must be |
752 | C<n> must be strictly positive (i.e. C<< >= 1 >>), while C<m> must be |
422 | negatable, that is, both C<m> and C<-m> must be representable in its |
753 | negatable, that is, both C<m> and C<-m> must be representable in its |
423 | type. |
754 | type (this typically excludes the minimum signed integer value, the same |
|
|
755 | limitation as for C</> and C<%> in C). |
|
|
756 | |
|
|
757 | Current GCC versions compile this into an efficient branchless sequence on |
|
|
758 | almost all CPUs. |
|
|
759 | |
|
|
760 | For example, when you want to rotate forward through the members of an |
|
|
761 | array for increasing C<m> (which might be negative), then you should use |
|
|
762 | C<ecb_mod>, as the C<%> operator might give either negative results, or |
|
|
763 | change direction for negative values: |
|
|
764 | |
|
|
765 | for (m = -100; m <= 100; ++m) |
|
|
766 | int elem = myarray [ecb_mod (m, ecb_array_length (myarray))]; |
|
|
767 | |
|
|
768 | =item x = ecb_div_rd (val, div) |
|
|
769 | |
|
|
770 | =item x = ecb_div_ru (val, div) |
|
|
771 | |
|
|
772 | Returns C<val> divided by C<div> rounded down or up, respectively. |
|
|
773 | C<val> and C<div> must have integer types and C<div> must be strictly |
|
|
774 | positive. Note that these functions are implemented with macros in C |
|
|
775 | and with function templates in C++. |
424 | |
776 | |
425 | =back |
777 | =back |
426 | |
778 | |
427 | =head2 UTILITY |
779 | =head2 UTILITY |
428 | |
780 | |
429 | =over 4 |
781 | =over 4 |
430 | |
782 | |
431 | =item element_count = ecb_array_length (name) [MACRO] |
783 | =item element_count = ecb_array_length (name) |
432 | |
784 | |
433 | Returns the number of elements in the array C<name>. For example: |
785 | Returns the number of elements in the array C<name>. For example: |
434 | |
786 | |
435 | int primes[] = { 2, 3, 5, 7, 11 }; |
787 | int primes[] = { 2, 3, 5, 7, 11 }; |
436 | int sum = 0; |
788 | int sum = 0; |
… | |
… | |
438 | for (i = 0; i < ecb_array_length (primes); i++) |
790 | for (i = 0; i < ecb_array_length (primes); i++) |
439 | sum += primes [i]; |
791 | sum += primes [i]; |
440 | |
792 | |
441 | =back |
793 | =back |
442 | |
794 | |
|
|
795 | =head2 SYMBOLS GOVERNING COMPILATION OF ECB.H ITSELF |
443 | |
796 | |
|
|
797 | These symbols need to be defined before including F<ecb.h> the first time. |
|
|
798 | |
|
|
799 | =over 4 |
|
|
800 | |
|
|
801 | =item ECB_NO_THREADS |
|
|
802 | |
|
|
803 | If F<ecb.h> is never used from multiple threads, then this symbol can |
|
|
804 | be defined, in which case memory fences (and similar constructs) are |
|
|
805 | completely removed, leading to more efficient code and fewer dependencies. |
|
|
806 | |
|
|
807 | Setting this symbol to a true value implies C<ECB_NO_SMP>. |
|
|
808 | |
|
|
809 | =item ECB_NO_SMP |
|
|
810 | |
|
|
811 | The weaker version of C<ECB_NO_THREADS> - if F<ecb.h> is used from |
|
|
812 | multiple threads, but never concurrently (e.g. if the system the program |
|
|
813 | runs on has only a single CPU with a single core, no hyperthreading and so |
|
|
814 | on), then this symbol can be defined, leading to more efficient code and |
|
|
815 | fewer dependencies. |
|
|
816 | |
|
|
817 | =item ECB_NO_LIBM |
|
|
818 | |
|
|
819 | When defined to C<1>, do not export any functions that might introduce |
|
|
820 | dependencies on the math library (usually called F<-lm>) - these are |
|
|
821 | marked with [-UECB_NO_LIBM]. |
|
|
822 | |
|
|
823 | =back |
|
|
824 | |
|
|
825 | |