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

Comparing libecb/ecb.pod (file contents):
Revision 1.32 by sf-exg, Fri Jun 17 15:55:41 2011 UTC vs.
Revision 1.63 by root, Wed Feb 18 20:29:38 2015 UTC

54only 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
55the corresponding function relies on C to implement the correct types, and 55the corresponding function relies on C to implement the correct types, and
56is usually implemented as a macro. Specifically, a "bool" in this manual 56is usually implemented as a macro. Specifically, a "bool" in this manual
57refers to any kind of boolean value, not a specific type. 57refers to any kind of boolean value, not a specific type.
58 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
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
71For C<ptrdiff_t> and C<size_t> use C<stddef.h>.
72
73=head2 LANGUAGE/ENVIRONMENT/COMPILER VERSIONS
74
75All the following symbols expand to an expression that can be tested in
76preprocessor instructions as well as treated as a boolean (use C<!!> to
77ensure it's either C<0> or C<1> if you need that).
78
79=over 4
80
81=item ECB_C
82
83True if the implementation defines the C<__STDC__> macro to a true value,
84while not claiming to be C++.
85
86=item ECB_C99
87
88True if the implementation claims to be compliant to C99 (ISO/IEC
899899:1999) or any later version, while not claiming to be C++.
90
91Note that later versions (ECB_C11) remove core features again (for
92example, variable length arrays).
93
94=item ECB_C11
95
96True if the implementation claims to be compliant to C11 (ISO/IEC
979899:2011) or any later version, while not claiming to be C++.
98
99=item ECB_CPP
100
101True if the implementation defines the C<__cplusplus__> macro to a true
102value, which is typically true for C++ compilers.
103
104=item ECB_CPP11
105
106True 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
111Expands to a true value (suitable for testing in by the preprocessor)
112if the compiler used is GNU C and the version is the given version, or
113higher.
114
115This macro tries to return false on compilers that claim to be GCC
116compatible but aren't.
117
118=item ECB_EXTERN_C
119
120Expands to C<extern "C"> in C++, and a simple C<extern> in C.
121
122This 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
128These two macros can be used to wrap multiple C<extern "C"> definitions -
129they expand to nothing in C.
130
131They 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
142If this evaluates to a true value (suitable for testing in by the
143preprocessor), then C<float> and C<double> use IEEE 754 single/binary32
144and double/binary64 representations internally I<and> the endianness of
145both types match the endianness of C<uint32_t> and C<uint64_t>.
146
147This means you can just copy the bits of a C<float> (or C<double>) to an
148C<uint32_t> (or C<uint64_t>) and get the raw IEEE 754 bit representation
149without having to think about format or endianness.
150
151This is true for basically all modern platforms, although F<ecb.h> might
152not be able to deduce this correctly everywhere and might err on the safe
153side.
154
155=item ECB_AMD64, ECB_AMD64_X32
156
157These two macros are defined to C<1> on the x86_64/amd64 ABI and the X32
158ABI, respectively, and undefined elsewhere.
159
160The designers of the new X32 ABI for some inexplicable reason decided to
161make it look exactly like amd64, even though it's completely incompatible
162to that ABI, breaking about every piece of software that assumed that
163C<__x86_64> stands for, well, the x86-64 ABI, making these macros
164necessary.
165
166=back
167
168=head2 MACRO TRICKERY
169
170=over 4
171
172=item ECB_CONCAT (a, b)
173
174Expands any macros in C<a> and C<b>, then concatenates the result to form
175a single token. This is mainly useful to form identifiers from components,
176e.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
185Expands any macros in C<arg> and returns the stringified version of
186it. This is mainly useful to get the contents of a macro in string form,
187e.g.:
188
189 #define SQL_LIMIT 100
190 sql_exec ("select * from table limit " ECB_STRINGIFY (SQL_LIMIT));
191
192=back
193
59=head2 GCC ATTRIBUTES 194=head2 ATTRIBUTES
60 195
61A major part of libecb deals with GCC attributes. These are additional 196A major part of libecb deals with additional attributes that can be
62attributes that you can assign to functions, variables and sometimes even 197assigned to functions, variables and sometimes even types - much like
63types - much like C<const> or C<volatile> in C. 198C<const> or C<volatile> in C. They are implemented using either GCC
64 199attributes or other compiler/language specific features. Attributes
65While GCC allows declarations to show up in many surprising places,
66but not in many expected places, the safest way is to put attribute
67declarations before the whole declaration: 200declarations must be put before the whole declaration:
68 201
69 ecb_const int mysqrt (int a); 202 ecb_const int mysqrt (int a);
70 ecb_unused int i; 203 ecb_unused int i;
71 204
72For variables, it is often nicer to put the attribute after the name, and
73avoid multiple declarations using commas:
74
75 int i ecb_unused;
76
77=over 4 205=over 4
78
79=item ecb_attribute ((attrs...))
80
81A simple wrapper that expands to C<__attribute__((attrs))> on GCC, and to
82nothing on other compilers, so the effect is that only GCC sees these.
83
84Example: use the C<deprecated> attribute on a function.
85
86 ecb_attribute((__deprecated__)) void
87 do_not_use_me_anymore (void);
88 206
89=item ecb_unused 207=item ecb_unused
90 208
91Marks a function or a variable as "unused", which simply suppresses a 209Marks a function or a variable as "unused", which simply suppresses a
92warning by GCC when it detects it as unused. This is useful when you e.g. 210warning by GCC when it detects it as unused. This is useful when you e.g.
93declare a variable but do not always use it: 211declare a variable but do not always use it:
94 212
95 { 213 {
96 int var ecb_unused; 214 ecb_unused int var;
97 215
98 #ifdef SOMECONDITION 216 #ifdef SOMECONDITION
99 var = ...; 217 var = ...;
100 return var; 218 return var;
101 #else 219 #else
102 return 0; 220 return 0;
103 #endif 221 #endif
104 } 222 }
105 223
224=item ecb_deprecated
225
226Similar to C<ecb_unused>, but marks a function, variable or type as
227deprecated. This makes some compilers warn when the type is used.
228
229=item ecb_deprecated_message (message)
230
231Same as C<ecb_deprecated>, but if possible, supply a diagnostic that is
232used instead of a generic depreciation message when the object is being
233used.
234
106=item ecb_inline 235=item ecb_inline
107 236
108This is not actually an attribute, but you use it like one. It expands
109either to C<static inline> or to just C<static>, if inline isn't 237Expands either to C<static inline> or to just C<static>, if inline
110supported. It should be used to declare functions that should be inlined, 238isn't supported. It should be used to declare functions that should be
111for code size or speed reasons. 239inlined, for code size or speed reasons.
112 240
113Example: inline this function, it surely will reduce codesize. 241Example: inline this function, it surely will reduce codesize.
114 242
115 ecb_inline int 243 ecb_inline int
116 negmul (int a, int b) 244 negmul (int a, int b)
138 } 266 }
139 267
140In this case, the compiler would probably be smart enough to deduce it on 268In this case, the compiler would probably be smart enough to deduce it on
141its own, so this is mainly useful for declarations. 269its own, so this is mainly useful for declarations.
142 270
271=item ecb_restrict
272
273Expands to the C<restrict> keyword or equivalent on compilers that support
274them, and to nothing on others. Must be specified on a pointer type or
275an array index to indicate that the memory doesn't alias with any other
276restricted pointer in the same scope.
277
278Example: multiply a vector, and allow the compiler to parallelise the
279loop, 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 }
291
143=item ecb_const 292=item ecb_const
144 293
145Declares that the function only depends on the values of its arguments, 294Declares that the function only depends on the values of its arguments,
146much like a mathematical function. It specifically does not read or write 295much like a mathematical function. It specifically does not read or write
147any memory any arguments might point to, global variables, or call any 296any memory any arguments might point to, global variables, or call any
207functions only called in exceptional or rare cases. 356functions only called in exceptional or rare cases.
208 357
209=item ecb_artificial 358=item ecb_artificial
210 359
211Declares the function as "artificial", in this case meaning that this 360Declares the function as "artificial", in this case meaning that this
212function is not really mean to be a function, but more like an accessor 361function is not really meant to be a function, but more like an accessor
213- 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
214crash reported in such a method, or single-stepping through them, is not 363crash reported in such a method, or single-stepping through them, is not
215usually so helpful, especially when it's inlined to just a few instructions. 364usually so helpful, especially when it's inlined to just a few instructions.
216 365
217Marking them as artificial will instruct the debugger about just this, 366Marking them as artificial will instruct the debugger about just this,
237 386
238=head2 OPTIMISATION HINTS 387=head2 OPTIMISATION HINTS
239 388
240=over 4 389=over 4
241 390
242=item bool ecb_is_constant(expr) 391=item bool ecb_is_constant (expr)
243 392
244Returns true iff the expression can be deduced to be a compile-time 393Returns true iff the expression can be deduced to be a compile-time
245constant, and false otherwise. 394constant, and false otherwise.
246 395
247For example, when you have a C<rndm16> function that returns a 16 bit 396For example, when you have a C<rndm16> function that returns a 16 bit
265 return is_constant (n) && !(n & (n - 1)) 414 return is_constant (n) && !(n & (n - 1))
266 ? rndm16 () & (num - 1) 415 ? rndm16 () & (num - 1)
267 : (n * (uint32_t)rndm16 ()) >> 16; 416 : (n * (uint32_t)rndm16 ()) >> 16;
268 } 417 }
269 418
270=item bool ecb_expect (expr, value) 419=item ecb_expect (expr, value)
271 420
272Evaluates C<expr> and returns it. In addition, it tells the compiler that 421Evaluates C<expr> and returns it. In addition, it tells the compiler that
273the C<expr> evaluates to C<value> a lot, which can be used for static 422the C<expr> evaluates to C<value> a lot, which can be used for static
274branch optimisations. 423branch optimisations.
275 424
322 { 471 {
323 if (ecb_expect_false (current + size > end)) 472 if (ecb_expect_false (current + size > end))
324 real_reserve_method (size); /* presumably noinline */ 473 real_reserve_method (size); /* presumably noinline */
325 } 474 }
326 475
327=item bool ecb_assume (cond) 476=item ecb_assume (cond)
328 477
329Try to tell the compiler that some condition is true, even if it's not 478Try to tell the compiler that some condition is true, even if it's not
330obvious. 479obvious.
331 480
332This can be used to teach the compiler about invariants or other 481This can be used to teach the compiler about invariants or other
352 501
353Then the compiler I<might> be able to optimise out the second call 502Then the compiler I<might> be able to optimise out the second call
354completely, as it knows that C<< current + 1 > end >> is false and the 503completely, as it knows that C<< current + 1 > end >> is false and the
355call will never be executed. 504call will never be executed.
356 505
357=item bool ecb_unreachable () 506=item ecb_unreachable ()
358 507
359This function does nothing itself, except tell the compiler that it will 508This function does nothing itself, except tell the compiler that it will
360never be executed. Apart from suppressing a warning in some cases, this 509never be executed. Apart from suppressing a warning in some cases, this
361function can be used to implement C<ecb_assume> or similar functions. 510function can be used to implement C<ecb_assume> or similar functions.
362 511
363=item bool ecb_prefetch (addr, rw, locality) 512=item ecb_prefetch (addr, rw, locality)
364 513
365Tells the compiler to try to prefetch memory at the given C<addr>ess 514Tells the compiler to try to prefetch memory at the given C<addr>ess
366for either reading (C<rw> = 0) or writing (C<rw> = 1). A C<locality> of 515for either reading (C<rw> = 0) or writing (C<rw> = 1). A C<locality> of
367C<0> means that there will only be one access later, C<3> means that 516C<0> means that there will only be one access later, C<3> means that
368the data will likely be accessed very often, and values in between mean 517the data will likely be accessed very often, and values in between mean
396After processing the node, (part of) the next node might already be in 545After processing the node, (part of) the next node might already be in
397cache. 546cache.
398 547
399=back 548=back
400 549
401=head2 BIT FIDDLING / BITSTUFFS 550=head2 BIT FIDDLING / BIT WIZARDRY
402 551
403=over 4 552=over 4
404 553
405=item bool ecb_big_endian () 554=item bool ecb_big_endian ()
406 555
412 561
413On systems that are neither, their return values are unspecified. 562On systems that are neither, their return values are unspecified.
414 563
415=item int ecb_ctz32 (uint32_t x) 564=item int ecb_ctz32 (uint32_t x)
416 565
566=item int ecb_ctz64 (uint64_t x)
567
417Returns the index of the least significant bit set in C<x> (or 568Returns the index of the least significant bit set in C<x> (or
418equivalently the number of bits set to 0 before the least significant bit 569equivalently the number of bits set to 0 before the least significant bit
419set), starting from 0. If C<x> is 0 the result is undefined. For example: 570set), starting from 0. If C<x> is 0 the result is undefined.
571
572For smaller types than C<uint32_t> you can safely use C<ecb_ctz32>.
573
574For example:
420 575
421 ecb_ctz32 (3) = 0 576 ecb_ctz32 (3) = 0
422 ecb_ctz32 (6) = 1 577 ecb_ctz32 (6) = 1
423 578
579=item bool ecb_is_pot32 (uint32_t x)
580
581=item bool ecb_is_pot64 (uint32_t x)
582
583Return true iff C<x> is a power of two or C<x == 0>.
584
585For 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
591Returns the index of the most significant bit set in C<x>, or the number
592of digits the number requires in binary (so that C<< 2**ld <= x <
5932**(ld+1) >>). If C<x> is 0 the result is undefined. A common use case is
594to compute the integer binary logarithm, i.e. C<floor (log2 (n))>, for
595example to see how many bits a certain number requires to be encoded.
596
597This function is similar to the "count leading zero bits" function, except
598that that one returns how many zero bits are "in front" of the number (in
599the given data type), while C<ecb_ld> returns how many bits the number
600itself requires.
601
602For smaller types than C<uint32_t> you can safely use C<ecb_ld32>.
603
424=item int ecb_popcount32 (uint32_t x) 604=item int ecb_popcount32 (uint32_t x)
425 605
606=item int ecb_popcount64 (uint64_t x)
607
426Returns the number of bits set to 1 in C<x>. For example: 608Returns the number of bits set to 1 in C<x>.
609
610For smaller types than C<uint32_t> you can safely use C<ecb_popcount32>.
611
612For example:
427 613
428 ecb_popcount32 (7) = 3 614 ecb_popcount32 (7) = 3
429 ecb_popcount32 (255) = 8 615 ecb_popcount32 (255) = 8
430 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
623Reverses the bits in x, i.e. the MSB becomes the LSB, MSB-1 becomes LSB+1
624and so on.
625
626Example:
627
628 ecb_bitrev8 (0xa7) = 0xea
629 ecb_bitrev32 (0xffcc4411) = 0x882233ff
630
431=item uint32_t ecb_bswap16 (uint32_t x) 631=item uint32_t ecb_bswap16 (uint32_t x)
432 632
433=item uint32_t ecb_bswap32 (uint32_t x) 633=item uint32_t ecb_bswap32 (uint32_t x)
434 634
635=item uint64_t ecb_bswap64 (uint64_t x)
636
435These two functions return the value of the 16-bit (32-bit) value C<x> 637These functions return the value of the 16-bit (32-bit, 64-bit) value
436after reversing the order of bytes (0x11223344 becomes 0x44332211). 638C<x> after reversing the order of bytes (0x11223344 becomes 0x44332211 in
639C<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)
437 652
438=item uint32_t ecb_rotr32 (uint32_t x, unsigned int count) 653=item uint32_t ecb_rotr32 (uint32_t x, unsigned int count)
439 654
440=item uint32_t ecb_rotl32 (uint32_t x, unsigned int count) 655=item uint64_t ecb_rotr64 (uint64_t x, unsigned int count)
441 656
442These two functions return the value of C<x> after rotating all the bits 657These two families of functions return the value of C<x> after rotating
443by C<count> positions to the right or left respectively. 658all the bits by C<count> positions to the right (C<ecb_rotr>) or left
659(C<ecb_rotl>).
444 660
445Current GCC versions understand these functions and usually compile them 661Current GCC versions understand these functions and usually compile them
446to "optimal" code (e.g. a single C<roll> on x86). 662to "optimal" code (e.g. a single C<rol> or a combination of C<shld> on
663x86).
664
665=back
666
667=head2 FLOATING POINT FIDDLING
668
669=over 4
670
671=item ECB_INFINITY
672
673Evaluates to positive infinity if supported by the platform, otherwise to
674a truly huge number.
675
676=item ECB_NAN
677
678Evaluates to a quiet NAN if supported by the platform, otherwise to
679C<ECB_INFINITY>.
680
681=item float ecb_ldexpf (float x, int exp)
682
683Same 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
689These functions each take an argument in the native C<float> or C<double>
690type and return the IEEE 754 bit representation of it.
691
692The bit representation is just as IEEE 754 defines it, i.e. the sign bit
693will be the most significant bit, followed by exponent and mantissa.
694
695This function should work even when the native floating point format isn't
696IEEE compliant, of course at a speed and code size penalty, and of course
697also within reasonable limits (it tries to convert NaNs, infinities and
698denormals, but will likely convert negative zero to positive zero).
699
700On all modern platforms (where C<ECB_STDFP> is true), the compiler should
701be able to optimise away this function completely.
702
703These functions can be helpful when serialising floats to the network - you
704can serialise the return value like a normal uint32_t/uint64_t.
705
706Another use for these functions is to manipulate floating point values
707directly.
708
709Silly 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
723The reverse operation of the previous function - takes the bit
724representation of an IEEE binary16, binary32 or binary64 number and
725converts it to the native C<float> or C<double> format.
726
727This function should work even when the native floating point format isn't
728IEEE compliant, of course at a speed and code size penalty, and of course
729also within reasonable limits (it tries to convert normals and denormals,
730and might be lucky for infinities, and with extraordinary luck, also for
731negative zero).
732
733On all modern platforms (where C<ECB_STDFP> is true), the compiler should
734be able to optimise away this function completely.
447 735
448=back 736=back
449 737
450=head2 ARITHMETIC 738=head2 ARITHMETIC
451 739
475change direction for negative values: 763change direction for negative values:
476 764
477 for (m = -100; m <= 100; ++m) 765 for (m = -100; m <= 100; ++m)
478 int elem = myarray [ecb_mod (m, ecb_array_length (myarray))]; 766 int elem = myarray [ecb_mod (m, ecb_array_length (myarray))];
479 767
768=item x = ecb_div_rd (val, div)
769
770=item x = ecb_div_ru (val, div)
771
772Returns C<val> divided by C<div> rounded down or up, respectively.
773C<val> and C<div> must have integer types and C<div> must be strictly
774positive. Note that these functions are implemented with macros in C
775and with function templates in C++.
776
480=back 777=back
481 778
482=head2 UTILITY 779=head2 UTILITY
483 780
484=over 4 781=over 4
493 for (i = 0; i < ecb_array_length (primes); i++) 790 for (i = 0; i < ecb_array_length (primes); i++)
494 sum += primes [i]; 791 sum += primes [i];
495 792
496=back 793=back
497 794
795=head2 SYMBOLS GOVERNING COMPILATION OF ECB.H ITSELF
498 796
797These symbols need to be defined before including F<ecb.h> the first time.
798
799=over 4
800
801=item ECB_NO_THREADS
802
803If F<ecb.h> is never used from multiple threads, then this symbol can
804be defined, in which case memory fences (and similar constructs) are
805completely removed, leading to more efficient code and fewer dependencies.
806
807Setting this symbol to a true value implies C<ECB_NO_SMP>.
808
809=item ECB_NO_SMP
810
811The weaker version of C<ECB_NO_THREADS> - if F<ecb.h> is used from
812multiple threads, but never concurrently (e.g. if the system the program
813runs on has only a single CPU with a single core, no hyperthreading and so
814on), then this symbol can be defined, leading to more efficient code and
815fewer dependencies.
816
817=item ECB_NO_LIBM
818
819When defined to C<1>, do not export any functions that might introduce
820dependencies on the math library (usually called F<-lm>) - these are
821marked with [-UECB_NO_LIBM].
822
823=back
824
825

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines