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

Comparing libecb/ecb.pod (file contents):
Revision 1.63 by root, Wed Feb 18 20:29:38 2015 UTC vs.
Revision 1.76 by root, Mon Jan 20 13:13:56 2020 UTC

58 58
59=head2 TYPES / TYPE SUPPORT 59=head2 TYPES / TYPE SUPPORT
60 60
61ecb.h makes sure that the following types are defined (in the expected way): 61ecb.h makes sure that the following types are defined (in the expected way):
62 62
63 int8_t uint8_t int16_t uint16_t 63 int8_t uint8_
64 int32_t uint32_t int64_t uint64_t 64 int16_t uint16_t
65 int32_t uint32_
66 int64_t uint64_t
67 int_fast8_t uint_fast8_t
68 int_fast16_t uint_fast16_t
69 int_fast32_t uint_fast32_t
70 int_fast64_t uint_fast64_t
65 intptr_t uintptr_t 71 intptr_t uintptr_t
66 72
67The macro C<ECB_PTRSIZE> is defined to the size of a pointer on this 73The 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 74platform (currently C<4> or C<8>) and can be used in preprocessor
69expressions. 75expressions.
70 76
71For C<ptrdiff_t> and C<size_t> use C<stddef.h>. 77For C<ptrdiff_t> and C<size_t> use C<stddef.h>/C<cstddef>.
72 78
73=head2 LANGUAGE/ENVIRONMENT/COMPILER VERSIONS 79=head2 LANGUAGE/ENVIRONMENT/COMPILER VERSIONS
74 80
75All the following symbols expand to an expression that can be tested in 81All the following symbols expand to an expression that can be tested in
76preprocessor instructions as well as treated as a boolean (use C<!!> to 82preprocessor instructions as well as treated as a boolean (use C<!!> to
899899:1999) or any later version, while not claiming to be C++. 959899:1999) or any later version, while not claiming to be C++.
90 96
91Note that later versions (ECB_C11) remove core features again (for 97Note that later versions (ECB_C11) remove core features again (for
92example, variable length arrays). 98example, variable length arrays).
93 99
94=item ECB_C11 100=item ECB_C11, ECB_C17
95 101
96True if the implementation claims to be compliant to C11 (ISO/IEC 102True if the implementation claims to be compliant to C11/C17 (ISO/IEC
979899:2011) or any later version, while not claiming to be C++. 1039899:2011, :20187) or any later version, while not claiming to be C++.
98 104
99=item ECB_CPP 105=item ECB_CPP
100 106
101True if the implementation defines the C<__cplusplus__> macro to a true 107True if the implementation defines the C<__cplusplus__> macro to a true
102value, which is typically true for C++ compilers. 108value, which is typically true for C++ compilers.
103 109
104=item ECB_CPP11 110=item ECB_CPP11, ECB_CPP14, ECB_CPP17
105 111
106True if the implementation claims to be compliant to ISO/IEC 14882:2011 112True if the implementation claims to be compliant to C++11/C++14/C++17
107(C++11) or any later version. 113(ISO/IEC 14882:2011, :2014, :2017) or any later version.
108 114
109=item ECB_GCC_VERSION (major, minor) 115=item ECB_GCC_VERSION (major, minor)
110 116
111Expands to a true value (suitable for testing in by the preprocessor) 117Expands 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 118if the compiler used is GNU C and the version is the given version, or
186it. This is mainly useful to get the contents of a macro in string form, 192it. This is mainly useful to get the contents of a macro in string form,
187e.g.: 193e.g.:
188 194
189 #define SQL_LIMIT 100 195 #define SQL_LIMIT 100
190 sql_exec ("select * from table limit " ECB_STRINGIFY (SQL_LIMIT)); 196 sql_exec ("select * from table limit " ECB_STRINGIFY (SQL_LIMIT));
197
198=item ECB_STRINGIFY_EXPR (expr)
199
200Like C<ECB_STRINGIFY>, but additionally evaluates C<expr> to make sure it
201is a valid expression. This is useful to catch typos or cases where the
202macro isn't available:
203
204 #include <errno.h>
205
206 ECB_STRINGIFY (EDOM); // "33" (on my system at least)
207 ECB_STRINGIFY_EXPR (EDOM); // "33"
208
209 // now imagine we had a typo:
210
211 ECB_STRINGIFY (EDAM); // "EDAM"
212 ECB_STRINGIFY_EXPR (EDAM); // error: EDAM undefined
191 213
192=back 214=back
193 215
194=head2 ATTRIBUTES 216=head2 ATTRIBUTES
195 217
226Similar to C<ecb_unused>, but marks a function, variable or type as 248Similar to C<ecb_unused>, but marks a function, variable or type as
227deprecated. This makes some compilers warn when the type is used. 249deprecated. This makes some compilers warn when the type is used.
228 250
229=item ecb_deprecated_message (message) 251=item ecb_deprecated_message (message)
230 252
231Same as C<ecb_deprecated>, but if possible, supply a diagnostic that is 253Same as C<ecb_deprecated>, but if possible, the specified diagnostic is
232used instead of a generic depreciation message when the object is being 254used instead of a generic depreciation message when the object is being
233used. 255used.
234 256
235=item ecb_inline 257=item ecb_inline
236 258
237Expands either to C<static inline> or to just C<static>, if inline 259Expands either to (a compiler-specific equivalent of) C<static inline> or
238isn't supported. It should be used to declare functions that should be 260to just C<static>, if inline isn't supported. It should be used to declare
239inlined, for code size or speed reasons. 261functions that should be inlined, for code size or speed reasons.
240 262
241Example: inline this function, it surely will reduce codesize. 263Example: inline this function, it surely will reduce codesize.
242 264
243 ecb_inline int 265 ecb_inline int
244 negmul (int a, int b) 266 negmul (int a, int b)
246 return - (a * b); 268 return - (a * b);
247 } 269 }
248 270
249=item ecb_noinline 271=item ecb_noinline
250 272
251Prevent a function from being inlined - it might be optimised away, but 273Prevents a function from being inlined - it might be optimised away, but
252not inlined into other functions. This is useful if you know your function 274not inlined into other functions. This is useful if you know your function
253is rarely called and large enough for inlining not to be helpful. 275is rarely called and large enough for inlining not to be helpful.
254 276
255=item ecb_noreturn 277=item ecb_noreturn
256 278
385=back 407=back
386 408
387=head2 OPTIMISATION HINTS 409=head2 OPTIMISATION HINTS
388 410
389=over 4 411=over 4
412
413=item ECB_OPTIMIZE_SIZE
414
415Is C<1> when the compiler optimizes for size, C<0> otherwise. This symbol
416can also be defined before including F<ecb.h>, in which case it will be
417unchanged.
390 418
391=item bool ecb_is_constant (expr) 419=item bool ecb_is_constant (expr)
392 420
393Returns true iff the expression can be deduced to be a compile-time 421Returns true iff the expression can be deduced to be a compile-time
394constant, and false otherwise. 422constant, and false otherwise.
473 real_reserve_method (size); /* presumably noinline */ 501 real_reserve_method (size); /* presumably noinline */
474 } 502 }
475 503
476=item ecb_assume (cond) 504=item ecb_assume (cond)
477 505
478Try to tell the compiler that some condition is true, even if it's not 506Tries to tell the compiler that some condition is true, even if it's not
479obvious. 507obvious. This is not a function, but a statement: it cannot be used in
508another expression.
480 509
481This can be used to teach the compiler about invariants or other 510This can be used to teach the compiler about invariants or other
482conditions that might improve code generation, but which are impossible to 511conditions that might improve code generation, but which are impossible to
483deduce form the code itself. 512deduce form the code itself.
484 513
505 534
506=item ecb_unreachable () 535=item ecb_unreachable ()
507 536
508This function does nothing itself, except tell the compiler that it will 537This function does nothing itself, except tell the compiler that it will
509never be executed. Apart from suppressing a warning in some cases, this 538never be executed. Apart from suppressing a warning in some cases, this
510function can be used to implement C<ecb_assume> or similar functions. 539function can be used to implement C<ecb_assume> or similar functionality.
511 540
512=item ecb_prefetch (addr, rw, locality) 541=item ecb_prefetch (addr, rw, locality)
513 542
514Tells the compiler to try to prefetch memory at the given C<addr>ess 543Tells the compiler to try to prefetch memory at the given C<addr>ess
515for either reading (C<rw> = 0) or writing (C<rw> = 1). A C<locality> of 544for either reading (C<rw> = 0) or writing (C<rw> = 1). A C<locality> of
517the data will likely be accessed very often, and values in between mean 546the data will likely be accessed very often, and values in between mean
518something... in between. The memory pointed to by the address does not 547something... in between. The memory pointed to by the address does not
519need to be accessible (it could be a null pointer for example), but C<rw> 548need to be accessible (it could be a null pointer for example), but C<rw>
520and C<locality> must be compile-time constants. 549and C<locality> must be compile-time constants.
521 550
551This is a statement, not a function: you cannot use it as part of an
552expression.
553
522An obvious way to use this is to prefetch some data far away, in a big 554An obvious way to use this is to prefetch some data far away, in a big
523array you loop over. This prefetches memory some 128 array elements later, 555array you loop over. This prefetches memory some 128 array elements later,
524in the hope that it will be ready when the CPU arrives at that location. 556in the hope that it will be ready when the CPU arrives at that location.
525 557
526 int sum = 0; 558 int sum = 0;
578 610
579=item bool ecb_is_pot32 (uint32_t x) 611=item bool ecb_is_pot32 (uint32_t x)
580 612
581=item bool ecb_is_pot64 (uint32_t x) 613=item bool ecb_is_pot64 (uint32_t x)
582 614
583Return true iff C<x> is a power of two or C<x == 0>. 615Returns true iff C<x> is a power of two or C<x == 0>.
584 616
585For smaller types then C<uint32_t> you can safely use C<ecb_is_pot32>. 617For smaller types than C<uint32_t> you can safely use C<ecb_is_pot32>.
586 618
587=item int ecb_ld32 (uint32_t x) 619=item int ecb_ld32 (uint32_t x)
588 620
589=item int ecb_ld64 (uint64_t x) 621=item int ecb_ld64 (uint64_t x)
590 622
636 668
637These functions return the value of the 16-bit (32-bit, 64-bit) value 669These functions return the value of the 16-bit (32-bit, 64-bit) value
638C<x> after reversing the order of bytes (0x11223344 becomes 0x44332211 in 670C<x> after reversing the order of bytes (0x11223344 becomes 0x44332211 in
639C<ecb_bswap32>). 671C<ecb_bswap32>).
640 672
673=item T ecb_bswap (T x) [C++]
674
675For C++, an additional generic bswap function is provided. It supports
676C<uint8_t>, C<uint16_t>, C<uint32_t> and C<uint64_t>.
677
641=item uint8_t ecb_rotl8 (uint8_t x, unsigned int count) 678=item uint8_t ecb_rotl8 (uint8_t x, unsigned int count)
642 679
643=item uint16_t ecb_rotl16 (uint16_t x, unsigned int count) 680=item uint16_t ecb_rotl16 (uint16_t x, unsigned int count)
644 681
645=item uint32_t ecb_rotl32 (uint32_t x, unsigned int count) 682=item uint32_t ecb_rotl32 (uint32_t x, unsigned int count)
662to "optimal" code (e.g. a single C<rol> or a combination of C<shld> on 699to "optimal" code (e.g. a single C<rol> or a combination of C<shld> on
663x86). 700x86).
664 701
665=back 702=back
666 703
704=head2 HOST ENDIANNESS CONVERSION
705
706=over 4
707
708=item uint_fast16_t ecb_be_u16_to_host (uint_fast16_t v)
709
710=item uint_fast32_t ecb_be_u32_to_host (uint_fast32_t v)
711
712=item uint_fast64_t ecb_be_u64_to_host (uint_fast64_t v)
713
714=item uint_fast16_t ecb_le_u16_to_host (uint_fast16_t v)
715
716=item uint_fast32_t ecb_le_u32_to_host (uint_fast32_t v)
717
718=item uint_fast64_t ecb_le_u64_to_host (uint_fast64_t v)
719
720Convert an unsigned 16, 32 or 64 bit value from big or little endian to host byte order.
721
722The naming convention is C<ecb_>(C<be>|C<le>)C<_u>C<16|32|64>C<_to_host>,
723where be and le stand for big endian and little endian, respectively.
724
725=item uint_fast16_t ecb_host_to_be_u16 (uint_fast16_t v)
726
727=item uint_fast32_t ecb_host_to_be_u32 (uint_fast32_t v)
728
729=item uint_fast64_t ecb_host_to_be_u64 (uint_fast64_t v)
730
731=item uint_fast16_t ecb_host_to_le_u16 (uint_fast16_t v)
732
733=item uint_fast32_t ecb_host_to_le_u32 (uint_fast32_t v)
734
735=item uint_fast64_t ecb_host_to_le_u64 (uint_fast64_t v)
736
737Like above, but converts I<from> host byte order to the specified
738endianness.
739
740=back
741
742In C++ the following additional functions are supported:
743
744=over 4
745
746=item T ecb_be_to_host (T v)
747
748=item T ecb_le_to_host (T v)
749
750=item T ecb_host_to_be (T v)
751
752=item T ecb_host_to_le (T v)
753
754These work like their C counterparts, above, but use templates for the
755type, which make them useful in generic code.
756
757C<T> must be one of C<uint8_t>, C<uint16_t>, C<uint32_t> or C<uint64_t>
758(so unlike their C counterparts, there is a version for C<uint8_t>, which
759again can be useful in generic code).
760
761=head2 UNALIGNED LOAD/STORE
762
763These function load or store unaligned multi-byte values.
764
765=over 4
766
767=item uint_fast16_t ecb_peek_u16_u (const void *ptr)
768
769=item uint_fast32_t ecb_peek_u32_u (const void *ptr)
770
771=item uint_fast64_t ecb_peek_u64_u (const void *ptr)
772
773These functions load an unaligned, unsigned 16, 32 or 64 bit value from
774memory.
775
776=item uint_fast16_t ecb_peek_be_u16_u (const void *ptr)
777
778=item uint_fast32_t ecb_peek_be_u32_u (const void *ptr)
779
780=item uint_fast64_t ecb_peek_be_u64_u (const void *ptr)
781
782=item uint_fast16_t ecb_peek_le_u16_u (const void *ptr)
783
784=item uint_fast32_t ecb_peek_le_u32_u (const void *ptr)
785
786=item uint_fast64_t ecb_peek_le_u64_u (const void *ptr)
787
788Like above, but additionally convert from big endian (C<be>) or little
789endian (C<le>) byte order to host byte order while doing so.
790
791=item ecb_poke_u16_u (void *ptr, uint16_t v)
792
793=item ecb_poke_u32_u (void *ptr, uint32_t v)
794
795=item ecb_poke_u64_u (void *ptr, uint64_t v)
796
797These functions store an unaligned, unsigned 16, 32 or 64 bit value to
798memory.
799
800=item ecb_poke_be_u16_u (void *ptr, uint_fast16_t v)
801
802=item ecb_poke_be_u32_u (void *ptr, uint_fast32_t v)
803
804=item ecb_poke_be_u64_u (void *ptr, uint_fast64_t v)
805
806=item ecb_poke_le_u16_u (void *ptr, uint_fast16_t v)
807
808=item ecb_poke_le_u32_u (void *ptr, uint_fast32_t v)
809
810=item ecb_poke_le_u64_u (void *ptr, uint_fast64_t v)
811
812Like above, but additionally convert from host byte order to big endian
813(C<be>) or little endian (C<le>) byte order while doing so.
814
815=back
816
817In C++ the following additional functions are supported:
818
819=over 4
820
821=item T ecb_peek (const void *ptr)
822
823=item T ecb_peek_be (const void *ptr)
824
825=item T ecb_peek_le (const void *ptr)
826
827=item T ecb_peek_u (const void *ptr)
828
829=item T ecb_peek_be_u (const void *ptr)
830
831=item T ecb_peek_le_u (const void *ptr)
832
833Similarly to their C counterparts, these functions load an unsigned 8, 16,
83432 or 64 bit value from memory, with optional conversion from big/little
835endian.
836
837Since the type cannot be deduced, it has top be specified explicitly, e.g.
838
839 uint_fast16_t v = ecb_peek<uint16_t> (ptr);
840
841C<T> must be one of C<uint8_t>, C<uint16_t>, C<uint32_t> or C<uint64_t>.
842
843Unlike their C counterparts, these functions support 8 bit quantities
844(C<uint8_t>) and also have an aligned version (without the C<_u> prefix),
845all of which hopefully makes them more useful in generic code.
846
847=item ecb_poke (void *ptr, T v)
848
849=item ecb_poke_be (void *ptr, T v)
850
851=item ecb_poke_le (void *ptr, T v)
852
853=item ecb_poke_u (void *ptr, T v)
854
855=item ecb_poke_be_u (void *ptr, T v)
856
857=item ecb_poke_le_u (void *ptr, T v)
858
859Again, similarly to their C counterparts, these functions store an
860unsigned 8, 16, 32 or z64 bit value to memory, with optional conversion to
861big/little endian.
862
863C<T> must be one of C<uint8_t>, C<uint16_t>, C<uint32_t> or C<uint64_t>.
864
865Unlike their C counterparts, these functions support 8 bit quantities
866(C<uint8_t>) and also have an aligned version (without the C<_u> prefix),
867all of which hopefully makes them more useful in generic code.
868
869=back
870
667=head2 FLOATING POINT FIDDLING 871=head2 FLOATING POINT FIDDLING
668 872
669=over 4 873=over 4
670 874
671=item ECB_INFINITY 875=item ECB_INFINITY [-UECB_NO_LIBM]
672 876
673Evaluates to positive infinity if supported by the platform, otherwise to 877Evaluates to positive infinity if supported by the platform, otherwise to
674a truly huge number. 878a truly huge number.
675 879
676=item ECB_NAN 880=item ECB_NAN [-UECB_NO_LIBM]
677 881
678Evaluates to a quiet NAN if supported by the platform, otherwise to 882Evaluates to a quiet NAN if supported by the platform, otherwise to
679C<ECB_INFINITY>. 883C<ECB_INFINITY>.
680 884
681=item float ecb_ldexpf (float x, int exp) 885=item float ecb_ldexpf (float x, int exp) [-UECB_NO_LIBM]
682 886
683Same as C<ldexpf>, but always available. 887Same as C<ldexpf>, but always available.
684 888
889=item uint32_t ecb_float_to_binary16 (float x) [-UECB_NO_LIBM]
890
685=item uint32_t ecb_float_to_binary32 (float x) [-UECB_NO_LIBM] 891=item uint32_t ecb_float_to_binary32 (float x) [-UECB_NO_LIBM]
686 892
687=item uint64_t ecb_double_to_binary64 (double x) [-UECB_NO_LIBM] 893=item uint64_t ecb_double_to_binary64 (double x) [-UECB_NO_LIBM]
688 894
689These functions each take an argument in the native C<float> or C<double> 895These functions each take an argument in the native C<float> or C<double>
690type and return the IEEE 754 bit representation of it. 896type and return the IEEE 754 bit representation of it (binary16/half,
897binary32/single or binary64/double precision).
691 898
692The bit representation is just as IEEE 754 defines it, i.e. the sign bit 899The 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. 900will be the most significant bit, followed by exponent and mantissa.
694 901
695This function should work even when the native floating point format isn't 902This function should work even when the native floating point format isn't
699 906
700On all modern platforms (where C<ECB_STDFP> is true), the compiler should 907On all modern platforms (where C<ECB_STDFP> is true), the compiler should
701be able to optimise away this function completely. 908be able to optimise away this function completely.
702 909
703These functions can be helpful when serialising floats to the network - you 910These functions can be helpful when serialising floats to the network - you
704can serialise the return value like a normal uint32_t/uint64_t. 911can serialise the return value like a normal uint16_t/uint32_t/uint64_t.
705 912
706Another use for these functions is to manipulate floating point values 913Another use for these functions is to manipulate floating point values
707directly. 914directly.
708 915
709Silly example: toggle the sign bit of a float. 916Silly example: toggle the sign bit of a float.
716 923
717=item float ecb_binary16_to_float (uint16_t x) [-UECB_NO_LIBM] 924=item float ecb_binary16_to_float (uint16_t x) [-UECB_NO_LIBM]
718 925
719=item float ecb_binary32_to_float (uint32_t x) [-UECB_NO_LIBM] 926=item float ecb_binary32_to_float (uint32_t x) [-UECB_NO_LIBM]
720 927
721=item double ecb_binary32_to_double (uint64_t x) [-UECB_NO_LIBM] 928=item double ecb_binary64_to_double (uint64_t x) [-UECB_NO_LIBM]
722 929
723The reverse operation of the previous function - takes the bit 930The reverse operation of the previous function - takes the bit
724representation of an IEEE binary16, binary32 or binary64 number and 931representation of an IEEE binary16, binary32 or binary64 number (half,
725converts it to the native C<float> or C<double> format. 932single or double precision) and converts it to the native C<float> or
933C<double> format.
726 934
727This function should work even when the native floating point format isn't 935This 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 936IEEE compliant, of course at a speed and code size penalty, and of course
729also within reasonable limits (it tries to convert normals and denormals, 937also within reasonable limits (it tries to convert normals and denormals,
730and might be lucky for infinities, and with extraordinary luck, also for 938and might be lucky for infinities, and with extraordinary luck, also for
731negative zero). 939negative zero).
732 940
733On all modern platforms (where C<ECB_STDFP> is true), the compiler should 941On all modern platforms (where C<ECB_STDFP> is true), the compiler should
734be able to optimise away this function completely. 942be able to optimise away this function completely.
943
944=item uint16_t ecb_binary32_to_binary16 (uint32_t x)
945
946=item uint32_t ecb_binary16_to_binary32 (uint16_t x)
947
948Convert a IEEE binary32/single precision to binary16/half format, and vice
949versa, handling all details (round-to-nearest-even, subnormals, infinity
950and NaNs) correctly.
951
952These are functions are available under C<-DECB_NO_LIBM>, since
953they do not rely on the platform floating point format. The
954C<ecb_float_to_binary16> and C<ecb_binary16_to_float> functions are
955usually what you want.
735 956
736=back 957=back
737 958
738=head2 ARITHMETIC 959=head2 ARITHMETIC
739 960
820dependencies on the math library (usually called F<-lm>) - these are 1041dependencies on the math library (usually called F<-lm>) - these are
821marked with [-UECB_NO_LIBM]. 1042marked with [-UECB_NO_LIBM].
822 1043
823=back 1044=back
824 1045
1046=head1 UNDOCUMENTED FUNCTIONALITY
825 1047
1048F<ecb.h> is full of undocumented functionality as well, some of which is
1049intended to be internal-use only, some of which we forgot to document, and
1050some of which we hide because we are not sure we will keep the interface
1051stable.
1052
1053While you are welcome to rummage around and use whatever you find useful
1054(we can't stop you), keep in mind that we will change undocumented
1055functionality in incompatible ways without thinking twice, while we are
1056considerably more conservative with documented things.
1057
1058=head1 AUTHORS
1059
1060C<libecb> is designed and maintained by:
1061
1062 Emanuele Giaquinta <e.giaquinta@glauco.it>
1063 Marc Alexander Lehmann <schmorp@schmorp.de>
1064
1065

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines