ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/cvsroot/libecb/ecb.pod
(Generate patch)

Comparing cvsroot/libecb/ecb.pod (file contents):
Revision 1.15 by root, Thu May 26 23:26:29 2011 UTC vs.
Revision 1.48 by root, Wed May 30 16:56:06 2012 UTC

3=head2 ABOUT LIBECB 3=head2 ABOUT LIBECB
4 4
5Libecb is currently a simple header file that doesn't require any 5Libecb is currently a simple header file that doesn't require any
6configuration to use or include in your project. 6configuration to use or include in your project.
7 7
8It's part of the e-suite of libraries, other memembers of which include 8It's part of the e-suite of libraries, other members of which include
9libev and libeio. 9libev and libeio.
10 10
11Its homepage can be found here: 11Its homepage can be found here:
12 12
13 http://software.schmorp.de/pkg/libecb 13 http://software.schmorp.de/pkg/libecb
14 14
15It mainly provides a number of wrappers around GCC built-ins, together 15It mainly provides a number of wrappers around GCC built-ins, together
16with replacement functions for other compilers. In addition to this, 16with replacement functions for other compilers. In addition to this,
17it provides a number of other lowlevel C utilities, such endienness 17it provides a number of other lowlevel C utilities, such as endianness
18detection, byte swapping or bit rotations. 18detection, byte swapping or bit rotations.
19
20Or in other words, things that should be built into any standard C system,
21but aren't, implemented as efficient as possible with GCC, and still
22correct with other compilers.
19 23
20More might come. 24More might come.
21 25
22=head2 ABOUT THE HEADER 26=head2 ABOUT THE HEADER
23 27
27 #include <ecb.h> 31 #include <ecb.h>
28 32
29The header should work fine for both C and C++ compilation, and gives you 33The header should work fine for both C and C++ compilation, and gives you
30all of F<inttypes.h> in addition to the ECB symbols. 34all of F<inttypes.h> in addition to the ECB symbols.
31 35
32There are currently no objetc files to link to - future versions might 36There are currently no object files to link to - future versions might
33come with an (optional) object code library to link against, to reduce 37come with an (optional) object code library to link against, to reduce
34code size or gain access to additional features. 38code size or gain access to additional features.
35 39
36It also currently includes everything from F<inttypes.h>. 40It also currently includes everything from F<inttypes.h>.
37 41
50only a generic name is used (C<expr>, C<cond>, C<value> and so on), then 54only a generic name is used (C<expr>, C<cond>, C<value> and so on), then
51the corresponding function relies on C to implement the correct types, and 55the corresponding function relies on C to implement the correct types, and
52is usually implemented as a macro. Specifically, a "bool" in this manual 56is usually implemented as a macro. Specifically, a "bool" in this manual
53refers to any kind of boolean value, not a specific type. 57refers to any kind of boolean value, not a specific type.
54 58
59=head2 TYPES / TYPE SUPPORT
60
61ecb.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 ptrdiff_t
66
67The macro C<ECB_PTRSIZE> is defined to the size of a pointer on this
68platform (currently C<4> or C<8>) and can be used in preprocessor
69expressions.
70
71=head2 LANGUAGE/COMPILER VERSIONS
72
73All the following symbols expand to an expression that can be tested in
74preprocessor instructions as well as treated as a boolean (use C<!!> to
75ensure it's either C<0> or C<1> if you need that).
76
77=over 4
78
79=item ECB_C
80
81True if the implementation defines the C<__STDC__> macro to a true value,
82which is typically true for both C and C++ compilers.
83
84=item ECB_C99
85
86True if the implementation claims to be compliant to C99 (ISO/IEC
879899:1999) or any later version.
88
89Note that later versions (ECB_C11) remove core features again (for
90example, variable length arrays).
91
92=item ECB_C11
93
94True if the implementation claims to be compliant to C11 (ISO/IEC
959899:2011) or any later version.
96
97=item ECB_CPP
98
99True if the implementation defines the C<__cplusplus__> macro to a true
100value, which is typically true for C++ compilers.
101
102=item ECB_CPP11
103
104True if the implementation claims to be compliant to ISO/IEC 14882:2011
105(C++11) or any later version.
106
107=item ECB_GCC_VERSION(major,minor)
108
109Expands to a true value (suitable for testing in by the preprocessor)
110if the compiler used is GNU C and the version is the given version, or
111higher.
112
113This macro tries to return false on compilers that claim to be GCC
114compatible but aren't.
115
116=back
117
55=head2 GCC ATTRIBUTES 118=head2 GCC ATTRIBUTES
56 119
57blabla where to put, what others 120A major part of libecb deals with GCC attributes. These are additional
121attributes that you can assign to functions, variables and sometimes even
122types - much like C<const> or C<volatile> in C.
123
124While GCC allows declarations to show up in many surprising places,
125but not in many expected places, the safest way is to put attribute
126declarations before the whole declaration:
127
128 ecb_const int mysqrt (int a);
129 ecb_unused int i;
130
131For variables, it is often nicer to put the attribute after the name, and
132avoid multiple declarations using commas:
133
134 int i ecb_unused;
58 135
59=over 4 136=over 4
60 137
61=item ecb_attribute ((attrs...)) 138=item ecb_attribute ((attrs...))
62 139
83 #else 160 #else
84 return 0; 161 return 0;
85 #endif 162 #endif
86 } 163 }
87 164
165=item ecb_inline
166
167This is not actually an attribute, but you use it like one. It expands
168either to C<static inline> or to just C<static>, if inline isn't
169supported. It should be used to declare functions that should be inlined,
170for code size or speed reasons.
171
172Example: inline this function, it surely will reduce codesize.
173
174 ecb_inline int
175 negmul (int a, int b)
176 {
177 return - (a * b);
178 }
179
88=item ecb_noinline 180=item ecb_noinline
89 181
90Prevent a function from being inlined - it might be optimised away, but 182Prevent a function from being inlined - it might be optimised away, but
91not inlined into other functions. This is useful if you know your function 183not inlined into other functions. This is useful if you know your function
92is rarely called and large enough for inlining not to be helpful. 184is rarely called and large enough for inlining not to be helpful.
93 185
94=item ecb_noreturn 186=item ecb_noreturn
95 187
188Marks a function as "not returning, ever". Some typical functions that
189don't return are C<exit> or C<abort> (which really works hard to not
190return), and now you can make your own:
191
192 ecb_noreturn void
193 my_abort (const char *errline)
194 {
195 puts (errline);
196 abort ();
197 }
198
199In this case, the compiler would probably be smart enough to deduce it on
200its own, so this is mainly useful for declarations.
201
96=item ecb_const 202=item ecb_const
97 203
204Declares that the function only depends on the values of its arguments,
205much like a mathematical function. It specifically does not read or write
206any memory any arguments might point to, global variables, or call any
207non-const functions. It also must not have any side effects.
208
209Such a function can be optimised much more aggressively by the compiler -
210for example, multiple calls with the same arguments can be optimised into
211a single call, which wouldn't be possible if the compiler would have to
212expect any side effects.
213
214It is best suited for functions in the sense of mathematical functions,
215such as a function returning the square root of its input argument.
216
217Not suited would be a function that calculates the hash of some memory
218area you pass in, prints some messages or looks at a global variable to
219decide on rounding.
220
221See C<ecb_pure> for a slightly less restrictive class of functions.
222
98=item ecb_pure 223=item ecb_pure
99 224
225Similar to C<ecb_const>, declares a function that has no side
226effects. Unlike C<ecb_const>, the function is allowed to examine global
227variables and any other memory areas (such as the ones passed to it via
228pointers).
229
230While these functions cannot be optimised as aggressively as C<ecb_const>
231functions, they can still be optimised away in many occasions, and the
232compiler has more freedom in moving calls to them around.
233
234Typical examples for such functions would be C<strlen> or C<memcmp>. A
235function that calculates the MD5 sum of some input and updates some MD5
236state passed as argument would I<NOT> be pure, however, as it would modify
237some memory area that is not the return value.
238
100=item ecb_hot 239=item ecb_hot
101 240
241This declares a function as "hot" with regards to the cache - the function
242is used so often, that it is very beneficial to keep it in the cache if
243possible.
244
245The compiler reacts by trying to place hot functions near to each other in
246memory.
247
248Whether a function is hot or not often depends on the whole program,
249and less on the function itself. C<ecb_cold> is likely more useful in
250practise.
251
102=item ecb_cold 252=item ecb_cold
103 253
254The opposite of C<ecb_hot> - declares a function as "cold" with regards to
255the cache, or in other words, this function is not called often, or not at
256speed-critical times, and keeping it in the cache might be a waste of said
257cache.
258
259In addition to placing cold functions together (or at least away from hot
260functions), this knowledge can be used in other ways, for example, the
261function will be optimised for size, as opposed to speed, and codepaths
262leading to calls to those functions can automatically be marked as if
263C<ecb_expect_false> had been used to reach them.
264
265Good examples for such functions would be error reporting functions, or
266functions only called in exceptional or rare cases.
267
104=item ecb_artificial 268=item ecb_artificial
269
270Declares the function as "artificial", in this case meaning that this
271function is not really mean to be a function, but more like an accessor
272- many methods in C++ classes are mere accessor functions, and having a
273crash reported in such a method, or single-stepping through them, is not
274usually so helpful, especially when it's inlined to just a few instructions.
275
276Marking them as artificial will instruct the debugger about just this,
277leading to happier debugging and thus happier lives.
278
279Example: in some kind of smart-pointer class, mark the pointer accessor as
280artificial, so that the whole class acts more like a pointer and less like
281some C++ abstraction monster.
282
283 template<typename T>
284 struct my_smart_ptr
285 {
286 T *value;
287
288 ecb_artificial
289 operator T *()
290 {
291 return value;
292 }
293 };
105 294
106=back 295=back
107 296
108=head2 OPTIMISATION HINTS 297=head2 OPTIMISATION HINTS
109 298
141 330
142Evaluates C<expr> and returns it. In addition, it tells the compiler that 331Evaluates C<expr> and returns it. In addition, it tells the compiler that
143the C<expr> evaluates to C<value> a lot, which can be used for static 332the C<expr> evaluates to C<value> a lot, which can be used for static
144branch optimisations. 333branch optimisations.
145 334
146Usually, you want to use the more intuitive C<ecb_likely> and 335Usually, you want to use the more intuitive C<ecb_expect_true> and
147C<ecb_unlikely> functions instead. 336C<ecb_expect_false> functions instead.
148 337
338=item bool ecb_expect_true (cond)
339
149=item bool ecb_likely (cond) 340=item bool ecb_expect_false (cond)
150
151=item bool ecb_unlikely (cond)
152 341
153These two functions expect a expression that is true or false and return 342These two functions expect a expression that is true or false and return
154C<1> or C<0>, respectively, so when used in the condition of an C<if> or 343C<1> or C<0>, respectively, so when used in the condition of an C<if> or
155other conditional statement, it will not change the program: 344other conditional statement, it will not change the program:
156 345
157 /* these two do the same thing */ 346 /* these two do the same thing */
158 if (some_condition) ...; 347 if (some_condition) ...;
159 if (ecb_likely (some_condition)) ...; 348 if (ecb_expect_true (some_condition)) ...;
160 349
161However, by using C<ecb_likely>, you tell the compiler that the condition 350However, by using C<ecb_expect_true>, you tell the compiler that the
162is likely to be true (and for C<ecb_unlikely>, that it is unlikely to be 351condition is likely to be true (and for C<ecb_expect_false>, that it is
163true). 352unlikely to be true).
164 353
165For example, when you check for a null pointer and expect this to be a 354For example, when you check for a null pointer and expect this to be a
166rare, exceptional, case, then use C<ecb_unlikely>: 355rare, exceptional, case, then use C<ecb_expect_false>:
167 356
168 void my_free (void *ptr) 357 void my_free (void *ptr)
169 { 358 {
170 if (ecb_unlikely (ptr == 0)) 359 if (ecb_expect_false (ptr == 0))
171 return; 360 return;
172 } 361 }
173 362
174Consequent use of these functions to mark away exceptional cases or to 363Consequent use of these functions to mark away exceptional cases or to
175tell the compiler what the hot path through a function is can increase 364tell the compiler what the hot path through a function is can increase
176performance considerably. 365performance considerably.
366
367You might know these functions under the name C<likely> and C<unlikely>
368- while these are common aliases, we find that the expect name is easier
369to understand when quickly skimming code. If you wish, you can use
370C<ecb_likely> instead of C<ecb_expect_true> and C<ecb_unlikely> instead of
371C<ecb_expect_false> - these are simply aliases.
177 372
178A very good example is in a function that reserves more space for some 373A very good example is in a function that reserves more space for some
179memory block (for example, inside an implementation of a string stream) - 374memory block (for example, inside an implementation of a string stream) -
180each time something is added, you have to check for a buffer overrun, but 375each time something is added, you have to check for a buffer overrun, but
181you expect that most checks will turn out to be false: 376you expect that most checks will turn out to be false:
182 377
183 /* make sure we have "size" extra room in our buffer */ 378 /* make sure we have "size" extra room in our buffer */
184 ecb_inline void 379 ecb_inline void
185 reserve (int size) 380 reserve (int size)
186 { 381 {
187 if (ecb_unlikely (current + size > end)) 382 if (ecb_expect_false (current + size > end))
188 real_reserve_method (size); /* presumably noinline */ 383 real_reserve_method (size); /* presumably noinline */
189 } 384 }
190 385
191=item bool ecb_assume (cond) 386=item bool ecb_assume (cond)
192 387
195 390
196This can be used to teach the compiler about invariants or other 391This can be used to teach the compiler about invariants or other
197conditions that might improve code generation, but which are impossible to 392conditions that might improve code generation, but which are impossible to
198deduce form the code itself. 393deduce form the code itself.
199 394
200For example, the example reservation function from the C<ecb_unlikely> 395For example, the example reservation function from the C<ecb_expect_false>
201description could be written thus (only C<ecb_assume> was added): 396description could be written thus (only C<ecb_assume> was added):
202 397
203 ecb_inline void 398 ecb_inline void
204 reserve (int size) 399 reserve (int size)
205 { 400 {
206 if (ecb_unlikely (current + size > end)) 401 if (ecb_expect_false (current + size > end))
207 real_reserve_method (size); /* presumably noinline */ 402 real_reserve_method (size); /* presumably noinline */
208 403
209 ecb_assume (current + size <= end); 404 ecb_assume (current + size <= end);
210 } 405 }
211 406
260After processing the node, (part of) the next node might already be in 455After processing the node, (part of) the next node might already be in
261cache. 456cache.
262 457
263=back 458=back
264 459
265=head2 BIT FIDDLING / BITSTUFFS 460=head2 BIT FIDDLING / BIT WIZARDRY
266 461
267=over 4 462=over 4
268 463
269=item bool ecb_big_endian () 464=item bool ecb_big_endian ()
270 465
272 467
273These two functions return true if the byte order is big endian 468These two functions return true if the byte order is big endian
274(most-significant byte first) or little endian (least-significant byte 469(most-significant byte first) or little endian (least-significant byte
275first) respectively. 470first) respectively.
276 471
472On systems that are neither, their return values are unspecified.
473
277=item int ecb_ctz32 (uint32_t x) 474=item int ecb_ctz32 (uint32_t x)
278 475
476=item int ecb_ctz64 (uint64_t x)
477
279Returns the index of the least significant bit set in C<x> (or 478Returns the index of the least significant bit set in C<x> (or
280equivalently the number of bits set to 0 before the least significant 479equivalently the number of bits set to 0 before the least significant bit
281bit set), starting from 0. If C<x> is 0 the result is undefined. A 480set), starting from 0. If C<x> is 0 the result is undefined.
282common use case is to compute the integer binary logarithm, i.e., 481
283floor(log2(n)). For example: 482For smaller types than C<uint32_t> you can safely use C<ecb_ctz32>.
483
484For example:
284 485
285 ecb_ctz32 (3) = 0 486 ecb_ctz32 (3) = 0
286 ecb_ctz32 (6) = 1 487 ecb_ctz32 (6) = 1
287 488
489=item bool ecb_is_pot32 (uint32_t x)
490
491=item bool ecb_is_pot64 (uint32_t x)
492
493Return true iff C<x> is a power of two or C<x == 0>.
494
495For smaller types then C<uint32_t> you can safely use C<ecb_is_pot32>.
496
497=item int ecb_ld32 (uint32_t x)
498
499=item int ecb_ld64 (uint64_t x)
500
501Returns the index of the most significant bit set in C<x>, or the number
502of digits the number requires in binary (so that C<< 2**ld <= x <
5032**(ld+1) >>). If C<x> is 0 the result is undefined. A common use case is
504to compute the integer binary logarithm, i.e. C<floor (log2 (n))>, for
505example to see how many bits a certain number requires to be encoded.
506
507This function is similar to the "count leading zero bits" function, except
508that that one returns how many zero bits are "in front" of the number (in
509the given data type), while C<ecb_ld> returns how many bits the number
510itself requires.
511
512For smaller types than C<uint32_t> you can safely use C<ecb_ld32>.
513
288=item int ecb_popcount32 (uint32_t x) 514=item int ecb_popcount32 (uint32_t x)
289 515
516=item int ecb_popcount64 (uint64_t x)
517
290Returns the number of bits set to 1 in C<x>. For example: 518Returns the number of bits set to 1 in C<x>.
519
520For smaller types than C<uint32_t> you can safely use C<ecb_popcount32>.
521
522For example:
291 523
292 ecb_popcount32 (7) = 3 524 ecb_popcount32 (7) = 3
293 ecb_popcount32 (255) = 8 525 ecb_popcount32 (255) = 8
294 526
527=item uint8_t ecb_bitrev8 (uint8_t x)
528
529=item uint16_t ecb_bitrev16 (uint16_t x)
530
531=item uint32_t ecb_bitrev32 (uint32_t x)
532
533Reverses the bits in x, i.e. the MSB becomes the LSB, MSB-1 becomes LSB+1
534and so on.
535
536Example:
537
538 ecb_bitrev8 (0xa7) = 0xea
539 ecb_bitrev32 (0xffcc4411) = 0x882233ff
540
295=item uint32_t ecb_bswap16 (uint32_t x) 541=item uint32_t ecb_bswap16 (uint32_t x)
296 542
297=item uint32_t ecb_bswap32 (uint32_t x) 543=item uint32_t ecb_bswap32 (uint32_t x)
298 544
545=item uint64_t ecb_bswap64 (uint64_t x)
546
299These two functions return the value of the 16-bit (32-bit) variable 547These functions return the value of the 16-bit (32-bit, 64-bit) value
300C<x> after reversing the order of bytes. 548C<x> after reversing the order of bytes (0x11223344 becomes 0x44332211 in
549C<ecb_bswap32>).
550
551=item uint8_t ecb_rotl8 (uint8_t x, unsigned int count)
552
553=item uint16_t ecb_rotl16 (uint16_t x, unsigned int count)
554
555=item uint32_t ecb_rotl32 (uint32_t x, unsigned int count)
556
557=item uint64_t ecb_rotl64 (uint64_t x, unsigned int count)
558
559=item uint8_t ecb_rotr8 (uint8_t x, unsigned int count)
560
561=item uint16_t ecb_rotr16 (uint16_t x, unsigned int count)
301 562
302=item uint32_t ecb_rotr32 (uint32_t x, unsigned int count) 563=item uint32_t ecb_rotr32 (uint32_t x, unsigned int count)
303 564
304=item uint32_t ecb_rotl32 (uint32_t x, unsigned int count) 565=item uint64_t ecb_rotr64 (uint64_t x, unsigned int count)
305 566
306These two functions return the value of C<x> after shifting all the bits 567These two families of functions return the value of C<x> after rotating
307by C<count> positions to the right or left respectively. 568all the bits by C<count> positions to the right (C<ecb_rotr>) or left
569(C<ecb_rotl>).
570
571Current GCC versions understand these functions and usually compile them
572to "optimal" code (e.g. a single C<rol> or a combination of C<shld> on
573x86).
308 574
309=back 575=back
310 576
311=head2 ARITHMETIC 577=head2 ARITHMETIC
312 578
313=over 4 579=over 4
314 580
315=item x = ecb_mod (m, n) 581=item x = ecb_mod (m, n)
316 582
317Returns the positive remainder of the modulo operation between C<m> and 583Returns C<m> modulo C<n>, which is the same as the positive remainder
584of the division operation between C<m> and C<n>, using floored
318C<n>. Unlike the C moduloe operator C<%>, this function ensures that the 585division. Unlike the C remainder operator C<%>, this function ensures that
319return value is always positive). 586the return value is always positive and that the two numbers I<m> and
587I<m' = m + i * n> result in the same value modulo I<n> - in other words,
588C<ecb_mod> implements the mathematical modulo operation, which is missing
589in the language.
320 590
321C<n> must be strictly positive (i.e. C<< >1 >>), while C<m> must be 591C<n> must be strictly positive (i.e. C<< >= 1 >>), while C<m> must be
322negatable, that is, both C<m> and C<-m> must be representable in its 592negatable, that is, both C<m> and C<-m> must be representable in its
323type. 593type (this typically excludes the minimum signed integer value, the same
594limitation as for C</> and C<%> in C).
595
596Current GCC versions compile this into an efficient branchless sequence on
597almost all CPUs.
598
599For example, when you want to rotate forward through the members of an
600array for increasing C<m> (which might be negative), then you should use
601C<ecb_mod>, as the C<%> operator might give either negative results, or
602change direction for negative values:
603
604 for (m = -100; m <= 100; ++m)
605 int elem = myarray [ecb_mod (m, ecb_array_length (myarray))];
606
607=item x = ecb_div_rd (val, div)
608
609=item x = ecb_div_ru (val, div)
610
611Returns C<val> divided by C<div> rounded down or up, respectively.
612C<val> and C<div> must have integer types and C<div> must be strictly
613positive. Note that these functions are implemented with macros in C
614and with function templates in C++.
324 615
325=back 616=back
326 617
327=head2 UTILITY 618=head2 UTILITY
328 619
329=over 4 620=over 4
330 621
331=item element_count = ecb_array_length (name) [MACRO] 622=item element_count = ecb_array_length (name)
332 623
333Returns the number of elements in the array C<name>. For example: 624Returns the number of elements in the array C<name>. For example:
334 625
335 int primes[] = { 2, 3, 5, 7, 11 }; 626 int primes[] = { 2, 3, 5, 7, 11 };
336 int sum = 0; 627 int sum = 0;
338 for (i = 0; i < ecb_array_length (primes); i++) 629 for (i = 0; i < ecb_array_length (primes); i++)
339 sum += primes [i]; 630 sum += primes [i];
340 631
341=back 632=back
342 633
634=head2 SYMBOLS GOVERNING COMPILATION OF ECB.H ITSELF
343 635
636These symbols need to be defined before including F<ecb.h> the first time.
637
638=over 4
639
640=item ECB_NO_THRADS
641
642If F<ecb.h> is never used from multiple threads, then this symbol can
643be defined, in which case memory fences (and similar constructs) are
644completely removed, leading to more efficient code and fewer dependencies.
645
646Setting this symbol to a true value implies C<ECB_NO_SMP>.
647
648=item ECB_NO_SMP
649
650The weaker version of C<ECB_NO_THREADS> - if F<ecb.h> is used from
651multiple threads, but never concurrently (e.g. if the system the program
652runs on has only a single CPU with a single core, no hyperthreading and so
653on), then this symbol can be defined, leading to more efficient code and
654fewer dependencies.
655
656=back
657
658

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines