… | |
… | |
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 aren'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 | |
… | |
… | |
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 GCC ATTRIBUTES |
59 | |
60 | |
60 | blabla where to put, what others |
61 | A major part of libecb deals with GCC attributes. These are additional |
|
|
62 | attributes that you can assign to functions, variables and sometimes even |
|
|
63 | types - much like C<const> or C<volatile> in C. |
|
|
64 | |
|
|
65 | While GCC allows declarations to show up in many surprising places, |
|
|
66 | but not in many expected places, the safest way is to put attribute |
|
|
67 | declarations before the whole declaration: |
|
|
68 | |
|
|
69 | ecb_const int mysqrt (int a); |
|
|
70 | ecb_unused int i; |
|
|
71 | |
|
|
72 | For variables, it is often nicer to put the attribute after the name, and |
|
|
73 | avoid multiple declarations using commas: |
|
|
74 | |
|
|
75 | int i ecb_unused; |
61 | |
76 | |
62 | =over 4 |
77 | =over 4 |
63 | |
78 | |
64 | =item ecb_attribute ((attrs...)) |
79 | =item ecb_attribute ((attrs...)) |
65 | |
80 | |
… | |
… | |
105 | { |
120 | { |
106 | puts (errline); |
121 | puts (errline); |
107 | abort (); |
122 | abort (); |
108 | } |
123 | } |
109 | |
124 | |
110 | In this case, the compiler would probbaly be smart enough to decude it on |
125 | 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. |
126 | its own, so this is mainly useful for declarations. |
112 | |
127 | |
113 | =item ecb_const |
128 | =item ecb_const |
114 | |
129 | |
115 | Declares that the function only depends on the values of it's arguments, |
130 | 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 |
131 | 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 |
132 | any memory any arguments might point to, global variables, or call any |
118 | non-const functions. It also must not have any side effects. |
133 | non-const functions. It also must not have any side effects. |
119 | |
134 | |
120 | Such a function can be optimised much more aggressively by the compiler - |
135 | 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 |
136 | 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 |
137 | a single call, which wouldn't be possible if the compiler would have to |
123 | expect any side effects. |
138 | expect any side effects. |
124 | |
139 | |
125 | It is best suited for functions in the sense of mathematical functions, |
140 | 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. |
141 | such as a function returning the square root of its input argument. |
127 | |
142 | |
128 | Not suited would be a function that calculates the hash of some memory |
143 | 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 |
144 | area you pass in, prints some messages or looks at a global variable to |
130 | decide on rounding. |
145 | decide on rounding. |
131 | |
146 | |
… | |
… | |
154 | possible. |
169 | possible. |
155 | |
170 | |
156 | The compiler reacts by trying to place hot functions near to each other in |
171 | The compiler reacts by trying to place hot functions near to each other in |
157 | memory. |
172 | memory. |
158 | |
173 | |
159 | Whether a function is hot or not often depend son the whole program, |
174 | 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 |
175 | and less on the function itself. C<ecb_cold> is likely more useful in |
161 | practise. |
176 | practise. |
162 | |
177 | |
163 | =item ecb_cold |
178 | =item ecb_cold |
164 | |
179 | |
… | |
… | |
169 | |
184 | |
170 | In addition to placing cold functions together (or at least away from hot |
185 | 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 |
186 | 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 |
187 | 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 |
188 | leading to calls to those functions can automatically be marked as if |
174 | C<ecb_unlikel> had been used to reach them. |
189 | C<ecb_expect_false> had been used to reach them. |
175 | |
190 | |
176 | Good examples for such functions would be error reporting functions, or |
191 | Good examples for such functions would be error reporting functions, or |
177 | functions only called in exceptional or rare cases. |
192 | functions only called in exceptional or rare cases. |
178 | |
193 | |
179 | =item ecb_artificial |
194 | =item ecb_artificial |
… | |
… | |
241 | |
256 | |
242 | Evaluates C<expr> and returns it. In addition, it tells the compiler that |
257 | 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 |
258 | the C<expr> evaluates to C<value> a lot, which can be used for static |
244 | branch optimisations. |
259 | branch optimisations. |
245 | |
260 | |
246 | Usually, you want to use the more intuitive C<ecb_likely> and |
261 | Usually, you want to use the more intuitive C<ecb_expect_true> and |
247 | C<ecb_unlikely> functions instead. |
262 | C<ecb_expect_false> functions instead. |
248 | |
263 | |
|
|
264 | =item bool ecb_expect_true (cond) |
|
|
265 | |
249 | =item bool ecb_likely (cond) |
266 | =item bool ecb_expect_false (cond) |
250 | |
|
|
251 | =item bool ecb_unlikely (cond) |
|
|
252 | |
267 | |
253 | These two functions expect a expression that is true or false and return |
268 | 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 |
269 | 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: |
270 | other conditional statement, it will not change the program: |
256 | |
271 | |
257 | /* these two do the same thing */ |
272 | /* these two do the same thing */ |
258 | if (some_condition) ...; |
273 | if (some_condition) ...; |
259 | if (ecb_likely (some_condition)) ...; |
274 | if (ecb_expect_true (some_condition)) ...; |
260 | |
275 | |
261 | However, by using C<ecb_likely>, you tell the compiler that the condition |
276 | 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 |
277 | condition is likely to be true (and for C<ecb_expect_false>, that it is |
263 | true). |
278 | unlikely to be true). |
264 | |
279 | |
265 | For example, when you check for a null pointer and expect this to be a |
280 | For example, when you check for a null pointer and expect this to be a |
266 | rare, exceptional, case, then use C<ecb_unlikely>: |
281 | rare, exceptional, case, then use C<ecb_expect_false>: |
267 | |
282 | |
268 | void my_free (void *ptr) |
283 | void my_free (void *ptr) |
269 | { |
284 | { |
270 | if (ecb_unlikely (ptr == 0)) |
285 | if (ecb_expect_false (ptr == 0)) |
271 | return; |
286 | return; |
272 | } |
287 | } |
273 | |
288 | |
274 | Consequent use of these functions to mark away exceptional cases or to |
289 | 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 |
290 | tell the compiler what the hot path through a function is can increase |
276 | performance considerably. |
291 | performance considerably. |
|
|
292 | |
|
|
293 | You might know these functions under the name C<likely> and C<unlikely> |
|
|
294 | - while these are common aliases, we find that the expect name is easier |
|
|
295 | to understand when quickly skimming code. If you wish, you can use |
|
|
296 | C<ecb_likely> instead of C<ecb_expect_true> and C<ecb_unlikely> instead of |
|
|
297 | C<ecb_expect_false> - these are simply aliases. |
277 | |
298 | |
278 | A very good example is in a function that reserves more space for some |
299 | 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) - |
300 | 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 |
301 | 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: |
302 | you expect that most checks will turn out to be false: |
282 | |
303 | |
283 | /* make sure we have "size" extra room in our buffer */ |
304 | /* make sure we have "size" extra room in our buffer */ |
284 | ecb_inline void |
305 | ecb_inline void |
285 | reserve (int size) |
306 | reserve (int size) |
286 | { |
307 | { |
287 | if (ecb_unlikely (current + size > end)) |
308 | if (ecb_expect_false (current + size > end)) |
288 | real_reserve_method (size); /* presumably noinline */ |
309 | real_reserve_method (size); /* presumably noinline */ |
289 | } |
310 | } |
290 | |
311 | |
291 | =item bool ecb_assume (cond) |
312 | =item bool ecb_assume (cond) |
292 | |
313 | |
… | |
… | |
295 | |
316 | |
296 | This can be used to teach the compiler about invariants or other |
317 | This can be used to teach the compiler about invariants or other |
297 | conditions that might improve code generation, but which are impossible to |
318 | conditions that might improve code generation, but which are impossible to |
298 | deduce form the code itself. |
319 | deduce form the code itself. |
299 | |
320 | |
300 | For example, the example reservation function from the C<ecb_unlikely> |
321 | For example, the example reservation function from the C<ecb_expect_false> |
301 | description could be written thus (only C<ecb_assume> was added): |
322 | description could be written thus (only C<ecb_assume> was added): |
302 | |
323 | |
303 | ecb_inline void |
324 | ecb_inline void |
304 | reserve (int size) |
325 | reserve (int size) |
305 | { |
326 | { |
306 | if (ecb_unlikely (current + size > end)) |
327 | if (ecb_expect_false (current + size > end)) |
307 | real_reserve_method (size); /* presumably noinline */ |
328 | real_reserve_method (size); /* presumably noinline */ |
308 | |
329 | |
309 | ecb_assume (current + size <= end); |
330 | ecb_assume (current + size <= end); |
310 | } |
331 | } |
311 | |
332 | |
… | |
… | |
372 | |
393 | |
373 | These two functions return true if the byte order is big endian |
394 | These two functions return true if the byte order is big endian |
374 | (most-significant byte first) or little endian (least-significant byte |
395 | (most-significant byte first) or little endian (least-significant byte |
375 | first) respectively. |
396 | first) respectively. |
376 | |
397 | |
|
|
398 | On systems that are neither, their return values are unspecified. |
|
|
399 | |
377 | =item int ecb_ctz32 (uint32_t x) |
400 | =item int ecb_ctz32 (uint32_t x) |
378 | |
401 | |
379 | Returns the index of the least significant bit set in C<x> (or |
402 | 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 |
403 | 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 |
404 | set), starting from 0. If C<x> is 0 the result is undefined. A common use |
382 | common use case is to compute the integer binary logarithm, i.e., |
405 | case is to compute the integer binary logarithm, i.e., C<floor (log2 |
383 | floor(log2(n)). For example: |
406 | (n))>. For example: |
384 | |
407 | |
385 | ecb_ctz32 (3) = 0 |
408 | ecb_ctz32 (3) = 0 |
386 | ecb_ctz32 (6) = 1 |
409 | ecb_ctz32 (6) = 1 |
387 | |
410 | |
388 | =item int ecb_popcount32 (uint32_t x) |
411 | =item int ecb_popcount32 (uint32_t x) |
… | |
… | |
394 | |
417 | |
395 | =item uint32_t ecb_bswap16 (uint32_t x) |
418 | =item uint32_t ecb_bswap16 (uint32_t x) |
396 | |
419 | |
397 | =item uint32_t ecb_bswap32 (uint32_t x) |
420 | =item uint32_t ecb_bswap32 (uint32_t x) |
398 | |
421 | |
399 | These two functions return the value of the 16-bit (32-bit) variable |
422 | These two functions return the value of the 16-bit (32-bit) value C<x> |
400 | C<x> after reversing the order of bytes. |
423 | after reversing the order of bytes (0x11223344 becomes 0x44332211). |
401 | |
424 | |
402 | =item uint32_t ecb_rotr32 (uint32_t x, unsigned int count) |
425 | =item uint32_t ecb_rotr32 (uint32_t x, unsigned int count) |
403 | |
426 | |
404 | =item uint32_t ecb_rotl32 (uint32_t x, unsigned int count) |
427 | =item uint32_t ecb_rotl32 (uint32_t x, unsigned int count) |
405 | |
428 | |
406 | These two functions return the value of C<x> after shifting all the bits |
429 | These two functions return the value of C<x> after rotating all the bits |
407 | by C<count> positions to the right or left respectively. |
430 | by C<count> positions to the right or left respectively. |
408 | |
431 | |
|
|
432 | Current GCC versions understand these functions and usually compile them |
|
|
433 | to "optimal" code (e.g. a single C<roll> on x86). |
|
|
434 | |
409 | =back |
435 | =back |
410 | |
436 | |
411 | =head2 ARITHMETIC |
437 | =head2 ARITHMETIC |
412 | |
438 | |
413 | =over 4 |
439 | =over 4 |
414 | |
440 | |
415 | =item x = ecb_mod (m, n) |
441 | =item x = ecb_mod (m, n) |
416 | |
442 | |
417 | Returns the positive remainder of the modulo operation between C<m> and |
443 | Returns C<m> modulo C<n>, which is the same as the positive remainder |
|
|
444 | 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 |
445 | division. Unlike the C remainder operator C<%>, this function ensures that |
419 | return value is always positive). |
446 | the return value is always positive and that the two numbers I<m> and |
|
|
447 | I<m' = m + i * n> result in the same value modulo I<n> - in other words, |
|
|
448 | C<ecb_mod> implements the mathematical modulo operation, which is missing |
|
|
449 | in the language. |
420 | |
450 | |
421 | C<n> must be strictly positive (i.e. C<< >1 >>), while C<m> must be |
451 | 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 |
452 | negatable, that is, both C<m> and C<-m> must be representable in its |
423 | type. |
453 | type (this typically includes the minimum signed integer value, the same |
|
|
454 | limitation as for C</> and C<%> in C). |
|
|
455 | |
|
|
456 | Current GCC versions compile this into an efficient branchless sequence on |
|
|
457 | many systems. |
|
|
458 | |
|
|
459 | For example, when you want to rotate forward through the members of an |
|
|
460 | array for increasing C<m> (which might be negative), then you should use |
|
|
461 | C<ecb_mod>, as the C<%> operator might give either negative results, or |
|
|
462 | change direction for negative values: |
|
|
463 | |
|
|
464 | for (m = -100; m <= 100; ++m) |
|
|
465 | int elem = myarray [ecb_mod (m, ecb_array_length (myarray))]; |
424 | |
466 | |
425 | =back |
467 | =back |
426 | |
468 | |
427 | =head2 UTILITY |
469 | =head2 UTILITY |
428 | |
470 | |
429 | =over 4 |
471 | =over 4 |
430 | |
472 | |
431 | =item element_count = ecb_array_length (name) [MACRO] |
473 | =item element_count = ecb_array_length (name) |
432 | |
474 | |
433 | Returns the number of elements in the array C<name>. For example: |
475 | Returns the number of elements in the array C<name>. For example: |
434 | |
476 | |
435 | int primes[] = { 2, 3, 5, 7, 11 }; |
477 | int primes[] = { 2, 3, 5, 7, 11 }; |
436 | int sum = 0; |
478 | int sum = 0; |