… | |
… | |
85 | =over 4 |
85 | =over 4 |
86 | |
86 | |
87 | =item ECB_C |
87 | =item ECB_C |
88 | |
88 | |
89 | True if the implementation defines the C<__STDC__> macro to a true value, |
89 | True if the implementation defines the C<__STDC__> macro to a true value, |
90 | while not claiming to be C++. |
90 | while not claiming to be C++, i..e C, but not C++. |
91 | |
91 | |
92 | =item ECB_C99 |
92 | =item ECB_C99 |
93 | |
93 | |
94 | True if the implementation claims to be compliant to C99 (ISO/IEC |
94 | True if the implementation claims to be compliant to C99 (ISO/IEC |
95 | 9899:1999) or any later version, while not claiming to be C++. |
95 | 9899:1999) or any later version, while not claiming to be C++. |
… | |
… | |
110 | =item ECB_CPP11, ECB_CPP14, ECB_CPP17 |
110 | =item ECB_CPP11, ECB_CPP14, ECB_CPP17 |
111 | |
111 | |
112 | True if the implementation claims to be compliant to C++11/C++14/C++17 |
112 | True if the implementation claims to be compliant to C++11/C++14/C++17 |
113 | (ISO/IEC 14882:2011, :2014, :2017) or any later version. |
113 | (ISO/IEC 14882:2011, :2014, :2017) or any later version. |
114 | |
114 | |
|
|
115 | Note that many C++20 features will likely have their own feature test |
|
|
116 | macros (see e.g. L<http://eel.is/c++draft/cpp.predefined#1.8>). |
|
|
117 | |
|
|
118 | =item ECB_OPTIMIZE_SIZE |
|
|
119 | |
|
|
120 | Is C<1> when the compiler optimizes for size, C<0> otherwise. This symbol |
|
|
121 | can also be defined before including F<ecb.h>, in which case it will be |
|
|
122 | unchanged. |
|
|
123 | |
115 | =item ECB_GCC_VERSION (major, minor) |
124 | =item ECB_GCC_VERSION (major, minor) |
116 | |
125 | |
117 | Expands to a true value (suitable for testing in by the preprocessor) |
126 | Expands to a true value (suitable for testing by the preprocessor) if the |
118 | if the compiler used is GNU C and the version is the given version, or |
127 | compiler used is GNU C and the version is the given version, or higher. |
119 | higher. |
|
|
120 | |
128 | |
121 | This macro tries to return false on compilers that claim to be GCC |
129 | This macro tries to return false on compilers that claim to be GCC |
122 | compatible but aren't. |
130 | compatible but aren't. |
123 | |
131 | |
124 | =item ECB_EXTERN_C |
132 | =item ECB_EXTERN_C |
… | |
… | |
143 | |
151 | |
144 | ECB_EXTERN_C_END |
152 | ECB_EXTERN_C_END |
145 | |
153 | |
146 | =item ECB_STDFP |
154 | =item ECB_STDFP |
147 | |
155 | |
148 | If this evaluates to a true value (suitable for testing in by the |
156 | If this evaluates to a true value (suitable for testing by the |
149 | preprocessor), then C<float> and C<double> use IEEE 754 single/binary32 |
157 | preprocessor), then C<float> and C<double> use IEEE 754 single/binary32 |
150 | and double/binary64 representations internally I<and> the endianness of |
158 | and double/binary64 representations internally I<and> the endianness of |
151 | both types match the endianness of C<uint32_t> and C<uint64_t>. |
159 | both types match the endianness of C<uint32_t> and C<uint64_t>. |
152 | |
160 | |
153 | This means you can just copy the bits of a C<float> (or C<double>) to an |
161 | This means you can just copy the bits of a C<float> (or C<double>) to an |
… | |
… | |
408 | |
416 | |
409 | =head2 OPTIMISATION HINTS |
417 | =head2 OPTIMISATION HINTS |
410 | |
418 | |
411 | =over 4 |
419 | =over 4 |
412 | |
420 | |
413 | =item ECB_OPTIMIZE_SIZE |
|
|
414 | |
|
|
415 | Is C<1> when the compiler optimizes for size, C<0> otherwise. This symbol |
|
|
416 | can also be defined before including F<ecb.h>, in which case it will be |
|
|
417 | unchanged. |
|
|
418 | |
|
|
419 | =item bool ecb_is_constant (expr) |
421 | =item bool ecb_is_constant (expr) |
420 | |
422 | |
421 | Returns true iff the expression can be deduced to be a compile-time |
423 | Returns true iff the expression can be deduced to be a compile-time |
422 | constant, and false otherwise. |
424 | constant, and false otherwise. |
423 | |
425 | |
… | |
… | |
595 | |
597 | |
596 | =item int ecb_ctz32 (uint32_t x) |
598 | =item int ecb_ctz32 (uint32_t x) |
597 | |
599 | |
598 | =item int ecb_ctz64 (uint64_t x) |
600 | =item int ecb_ctz64 (uint64_t x) |
599 | |
601 | |
|
|
602 | =item int ecb_ctz (T x) [C++] |
|
|
603 | |
600 | Returns the index of the least significant bit set in C<x> (or |
604 | Returns the index of the least significant bit set in C<x> (or |
601 | equivalently the number of bits set to 0 before the least significant bit |
605 | equivalently the number of bits set to 0 before the least significant bit |
602 | set), starting from 0. If C<x> is 0 the result is undefined. |
606 | set), starting from 0. If C<x> is 0 the result is undefined. |
603 | |
607 | |
604 | For smaller types than C<uint32_t> you can safely use C<ecb_ctz32>. |
608 | For smaller types than C<uint32_t> you can safely use C<ecb_ctz32>. |
605 | |
609 | |
|
|
610 | The overloaded C++ C<ecb_ctz> function supports C<uint8_t>, C<uint16_t>, |
|
|
611 | C<uint32_t> and C<uint64_t> types. |
|
|
612 | |
606 | For example: |
613 | For example: |
607 | |
614 | |
608 | ecb_ctz32 (3) = 0 |
615 | ecb_ctz32 (3) = 0 |
609 | ecb_ctz32 (6) = 1 |
616 | ecb_ctz32 (6) = 1 |
610 | |
617 | |
611 | =item bool ecb_is_pot32 (uint32_t x) |
618 | =item bool ecb_is_pot32 (uint32_t x) |
612 | |
619 | |
613 | =item bool ecb_is_pot64 (uint32_t x) |
620 | =item bool ecb_is_pot64 (uint32_t x) |
614 | |
621 | |
|
|
622 | =item bool ecb_is_pot (T x) [C++] |
|
|
623 | |
615 | Returns true iff C<x> is a power of two or C<x == 0>. |
624 | Returns true iff C<x> is a power of two or C<x == 0>. |
616 | |
625 | |
617 | For smaller types than C<uint32_t> you can safely use C<ecb_is_pot32>. |
626 | For smaller types than C<uint32_t> you can safely use C<ecb_is_pot32>. |
618 | |
627 | |
|
|
628 | The overloaded C++ C<ecb_is_pot> function supports C<uint8_t>, C<uint16_t>, |
|
|
629 | C<uint32_t> and C<uint64_t> types. |
|
|
630 | |
619 | =item int ecb_ld32 (uint32_t x) |
631 | =item int ecb_ld32 (uint32_t x) |
620 | |
632 | |
621 | =item int ecb_ld64 (uint64_t x) |
633 | =item int ecb_ld64 (uint64_t x) |
|
|
634 | |
|
|
635 | =item int ecb_ld64 (T x) [C++] |
622 | |
636 | |
623 | Returns the index of the most significant bit set in C<x>, or the number |
637 | Returns the index of the most significant bit set in C<x>, or the number |
624 | of digits the number requires in binary (so that C<< 2**ld <= x < |
638 | of digits the number requires in binary (so that C<< 2**ld <= x < |
625 | 2**(ld+1) >>). If C<x> is 0 the result is undefined. A common use case is |
639 | 2**(ld+1) >>). If C<x> is 0 the result is undefined. A common use case is |
626 | to compute the integer binary logarithm, i.e. C<floor (log2 (n))>, for |
640 | to compute the integer binary logarithm, i.e. C<floor (log2 (n))>, for |
… | |
… | |
631 | the given data type), while C<ecb_ld> returns how many bits the number |
645 | the given data type), while C<ecb_ld> returns how many bits the number |
632 | itself requires. |
646 | itself requires. |
633 | |
647 | |
634 | For smaller types than C<uint32_t> you can safely use C<ecb_ld32>. |
648 | For smaller types than C<uint32_t> you can safely use C<ecb_ld32>. |
635 | |
649 | |
|
|
650 | The overloaded C++ C<ecb_ld> function supports C<uint8_t>, C<uint16_t>, |
|
|
651 | C<uint32_t> and C<uint64_t> types. |
|
|
652 | |
636 | =item int ecb_popcount32 (uint32_t x) |
653 | =item int ecb_popcount32 (uint32_t x) |
637 | |
654 | |
638 | =item int ecb_popcount64 (uint64_t x) |
655 | =item int ecb_popcount64 (uint64_t x) |
639 | |
656 | |
|
|
657 | =item int ecb_popcount (T x) [C++] |
|
|
658 | |
640 | Returns the number of bits set to 1 in C<x>. |
659 | Returns the number of bits set to 1 in C<x>. |
641 | |
660 | |
642 | For smaller types than C<uint32_t> you can safely use C<ecb_popcount32>. |
661 | For smaller types than C<uint32_t> you can safely use C<ecb_popcount32>. |
|
|
662 | |
|
|
663 | The overloaded C++ C<ecb_popcount> function supports C<uint8_t>, C<uint16_t>, |
|
|
664 | C<uint32_t> and C<uint64_t> types. |
643 | |
665 | |
644 | For example: |
666 | For example: |
645 | |
667 | |
646 | ecb_popcount32 (7) = 3 |
668 | ecb_popcount32 (7) = 3 |
647 | ecb_popcount32 (255) = 8 |
669 | ecb_popcount32 (255) = 8 |
… | |
… | |
650 | |
672 | |
651 | =item uint16_t ecb_bitrev16 (uint16_t x) |
673 | =item uint16_t ecb_bitrev16 (uint16_t x) |
652 | |
674 | |
653 | =item uint32_t ecb_bitrev32 (uint32_t x) |
675 | =item uint32_t ecb_bitrev32 (uint32_t x) |
654 | |
676 | |
|
|
677 | =item T ecb_bitrev (T x) [C++] |
|
|
678 | |
655 | Reverses the bits in x, i.e. the MSB becomes the LSB, MSB-1 becomes LSB+1 |
679 | Reverses the bits in x, i.e. the MSB becomes the LSB, MSB-1 becomes LSB+1 |
656 | and so on. |
680 | and so on. |
657 | |
681 | |
|
|
682 | The overloaded C++ C<ecb_bitrev> function supports C<uint8_t>, C<uint16_t> and C<uint32_t> types. |
|
|
683 | |
658 | Example: |
684 | Example: |
659 | |
685 | |
660 | ecb_bitrev8 (0xa7) = 0xea |
686 | ecb_bitrev8 (0xa7) = 0xea |
661 | ecb_bitrev32 (0xffcc4411) = 0x882233ff |
687 | ecb_bitrev32 (0xffcc4411) = 0x882233ff |
662 | |
688 | |
|
|
689 | =item T ecb_bitrev (T x) [C++] |
|
|
690 | |
|
|
691 | Overloaded C++ bitrev function. |
|
|
692 | |
|
|
693 | C<T> must be one of C<uint8_t>, C<uint16_t> or C<uint32_t>. |
|
|
694 | |
663 | =item uint32_t ecb_bswap16 (uint32_t x) |
695 | =item uint32_t ecb_bswap16 (uint32_t x) |
664 | |
696 | |
665 | =item uint32_t ecb_bswap32 (uint32_t x) |
697 | =item uint32_t ecb_bswap32 (uint32_t x) |
666 | |
698 | |
667 | =item uint64_t ecb_bswap64 (uint64_t x) |
699 | =item uint64_t ecb_bswap64 (uint64_t x) |
|
|
700 | |
|
|
701 | =item T ecb_bswap (T x) |
668 | |
702 | |
669 | These functions return the value of the 16-bit (32-bit, 64-bit) value |
703 | These functions return the value of the 16-bit (32-bit, 64-bit) value |
670 | C<x> after reversing the order of bytes (0x11223344 becomes 0x44332211 in |
704 | C<x> after reversing the order of bytes (0x11223344 becomes 0x44332211 in |
671 | C<ecb_bswap32>). |
705 | C<ecb_bswap32>). |
672 | |
706 | |
673 | =item T ecb_bswap (T x) [C++] |
707 | The overloaded C++ C<ecb_bswap> function supports C<uint8_t>, C<uint16_t>, |
674 | |
708 | C<uint32_t> and C<uint64_t> types. |
675 | For C++, an additional generic bswap function is provided. It supports |
|
|
676 | C<uint8_t>, C<uint16_t>, C<uint32_t> and C<uint64_t>. |
|
|
677 | |
709 | |
678 | =item uint8_t ecb_rotl8 (uint8_t x, unsigned int count) |
710 | =item uint8_t ecb_rotl8 (uint8_t x, unsigned int count) |
679 | |
711 | |
680 | =item uint16_t ecb_rotl16 (uint16_t x, unsigned int count) |
712 | =item uint16_t ecb_rotl16 (uint16_t x, unsigned int count) |
681 | |
713 | |
… | |
… | |
697 | |
729 | |
698 | Current GCC versions understand these functions and usually compile them |
730 | Current GCC versions understand these functions and usually compile them |
699 | to "optimal" code (e.g. a single C<rol> or a combination of C<shld> on |
731 | to "optimal" code (e.g. a single C<rol> or a combination of C<shld> on |
700 | x86). |
732 | x86). |
701 | |
733 | |
|
|
734 | =item T ecb_rotl (T x, unsigned int count) [C++] |
|
|
735 | |
|
|
736 | =item T ecb_rotr (T x, unsigned int count) [C++] |
|
|
737 | |
|
|
738 | Overloaded C++ rotl/rotr functions. |
|
|
739 | |
|
|
740 | C<T> must be one of C<uint8_t>, C<uint16_t>, C<uint32_t> or C<uint64_t>. |
|
|
741 | |
702 | =back |
742 | =back |
703 | |
743 | |
704 | =head2 HOST ENDIANNESS CONVERSION |
744 | =head2 HOST ENDIANNESS CONVERSION |
705 | |
745 | |
706 | =over 4 |
746 | =over 4 |
… | |
… | |
718 | =item uint_fast64_t ecb_le_u64_to_host (uint_fast64_t v) |
758 | =item uint_fast64_t ecb_le_u64_to_host (uint_fast64_t v) |
719 | |
759 | |
720 | Convert an unsigned 16, 32 or 64 bit value from big or little endian to host byte order. |
760 | Convert an unsigned 16, 32 or 64 bit value from big or little endian to host byte order. |
721 | |
761 | |
722 | The naming convention is C<ecb_>(C<be>|C<le>)C<_u>C<16|32|64>C<_to_host>, |
762 | The naming convention is C<ecb_>(C<be>|C<le>)C<_u>C<16|32|64>C<_to_host>, |
723 | where be and le stand for big endian and little endian, respectively. |
763 | where C<be> and C<le> stand for big endian and little endian, respectively. |
724 | |
764 | |
725 | =item uint_fast16_t ecb_host_to_be_u16 (uint_fast16_t v) |
765 | =item uint_fast16_t ecb_host_to_be_u16 (uint_fast16_t v) |
726 | |
766 | |
727 | =item uint_fast32_t ecb_host_to_be_u32 (uint_fast32_t v) |
767 | =item uint_fast32_t ecb_host_to_be_u32 (uint_fast32_t v) |
728 | |
768 | |
… | |
… | |
737 | Like above, but converts I<from> host byte order to the specified |
777 | Like above, but converts I<from> host byte order to the specified |
738 | endianness. |
778 | endianness. |
739 | |
779 | |
740 | =back |
780 | =back |
741 | |
781 | |
742 | In C++ the following additional functions are supported: |
782 | In C++ the following additional template functions are supported: |
743 | |
783 | |
744 | =over 4 |
784 | =over 4 |
745 | |
785 | |
746 | =item T ecb_be_to_host (T v) |
786 | =item T ecb_be_to_host (T v) |
747 | |
787 | |
… | |
… | |
749 | |
789 | |
750 | =item T ecb_host_to_be (T v) |
790 | =item T ecb_host_to_be (T v) |
751 | |
791 | |
752 | =item T ecb_host_to_le (T v) |
792 | =item T ecb_host_to_le (T v) |
753 | |
793 | |
754 | These work like their C counterparts, above, but use templates for the |
794 | These functions work like their C counterparts, above, but use templates, |
755 | type, which make them useful in generic code. |
795 | which make them useful in generic code. |
756 | |
796 | |
757 | C<T> must be one of C<uint8_t>, C<uint16_t>, C<uint32_t> or C<uint64_t> |
797 | C<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 |
798 | (so unlike their C counterparts, there is a version for C<uint8_t>, which |
759 | again can be useful in generic code). |
799 | again can be useful in generic code). |
760 | |
800 | |
… | |
… | |
812 | Like above, but additionally convert from host byte order to big endian |
852 | Like above, but additionally convert from host byte order to big endian |
813 | (C<be>) or little endian (C<le>) byte order while doing so. |
853 | (C<be>) or little endian (C<le>) byte order while doing so. |
814 | |
854 | |
815 | =back |
855 | =back |
816 | |
856 | |
817 | In C++ the following additional functions are supported: |
857 | In C++ the following additional template functions are supported: |
818 | |
858 | |
819 | =over 4 |
859 | =over 4 |
820 | |
860 | |
821 | =item T ecb_peek (const void *ptr) |
861 | =item T ecb_peek<T> (const void *ptr) |
822 | |
862 | |
823 | =item T ecb_peek_be (const void *ptr) |
863 | =item T ecb_peek_be<T> (const void *ptr) |
824 | |
864 | |
825 | =item T ecb_peek_le (const void *ptr) |
865 | =item T ecb_peek_le<T> (const void *ptr) |
826 | |
866 | |
827 | =item T ecb_peek_u (const void *ptr) |
867 | =item T ecb_peek_u<T> (const void *ptr) |
828 | |
868 | |
829 | =item T ecb_peek_be_u (const void *ptr) |
869 | =item T ecb_peek_be_u<T> (const void *ptr) |
830 | |
870 | |
831 | =item T ecb_peek_le_u (const void *ptr) |
871 | =item T ecb_peek_le_u<T> (const void *ptr) |
832 | |
872 | |
833 | Similarly to their C counterparts, these functions load an unsigned 8, 16, |
873 | Similarly to their C counterparts, these functions load an unsigned 8, 16, |
834 | 32 or 64 bit value from memory, with optional conversion from big/little |
874 | 32 or 64 bit value from memory, with optional conversion from big/little |
835 | endian. |
875 | endian. |
836 | |
876 | |
837 | Since the type cannot be deduced, it has top be specified explicitly, e.g. |
877 | Since the type cannot be deduced, it has to be specified explicitly, e.g. |
838 | |
878 | |
839 | uint_fast16_t v = ecb_peek<uint16_t> (ptr); |
879 | uint_fast16_t v = ecb_peek<uint16_t> (ptr); |
840 | |
880 | |
841 | C<T> must be one of C<uint8_t>, C<uint16_t>, C<uint32_t> or C<uint64_t>. |
881 | C<T> must be one of C<uint8_t>, C<uint16_t>, C<uint32_t> or C<uint64_t>. |
842 | |
882 | |