block/include/nil/crypto3/detail/reverser.hpp

Go to the documentation of this file.

//---------------------------------------------------------------------------//
// Copyright (c) 2018-2020 Mikhail Komarov <nemo@nil.foundation>
// Copyright (c) 2020 Alexander Sokolov <asokolov@nil.foundation>
// Copyright (c) 2020 Nikita Kaskov <nbering@nil.foundation>
//
// MIT License
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//---------------------------------------------------------------------------//
 
#ifndef CRYPTO3_DETAIL_REVERSER_HPP
#define CRYPTO3_DETAIL_REVERSER_HPP
 
#include <climits>
#include <type_traits>
 
#include <boost/integer.hpp>
#include <boost/static_assert.hpp>
#include <boost/endian/conversion.hpp>
 
#include <nil/crypto3/detail/unbounded_shift.hpp>
#include <nil/crypto3/detail/stream_endian.hpp>
#include <nil/crypto3/detail/predef.hpp>
 
namespace nil {
    namespace crypto3 {
        namespace detail {
 
            typedef typename boost::uint_t<CHAR_BIT>::exact byte_type;
 
            inline void reverse_byte(byte_type &b) {
 
#if (BOOST_ARCH_CURRENT_WORD_BITS == 32)
                b = unbounded_shr<16>(((b * 0x0802LU & 0x22110LU) | (b * 0x8020LU & 0x88440LU)) * 0x10101LU);
#elif (BOOST_ARCH_CURRENT_WORD_BITS == 64)
                b = (b * 0x0202020202ULL & 0x010884422010ULL) % 1023;
#else                
#error "BOOST_ARCH_CURRENT_WORD_BITS not set"
#endif
            }
 
            template<int UnitBits, int k = 0>
            struct bit_in_unit_byte_reverser {
 
                BOOST_STATIC_ASSERT(!(UnitBits % CHAR_BIT));
 
                typedef bit_in_unit_byte_reverser<UnitBits, k + CHAR_BIT> next_type;
                typedef typename boost::uint_t<UnitBits>::exact UnitType;
 
                inline static void reverse(UnitType &in, UnitType &out) {
                    int const shift = UnitBits - (CHAR_BIT + k);
                    byte_type byte = byte_type(low_bits<CHAR_BIT>(unbounded_shr(in, shift)));
                    reverse_byte(byte);
                    out |= unbounded_shl(low_bits<CHAR_BIT>(UnitType(byte)), shift);
 
                    next_type::reverse(in, out);
                }
            };
 
            template<int UnitBits>
            struct bit_in_unit_byte_reverser<UnitBits, UnitBits> {
                inline static void reverse(typename boost::uint_t<UnitBits>::exact &,
                                           typename boost::uint_t<UnitBits>::exact &) {
                }
            };
 
            template<typename UnitType,
                     int UnitBits = sizeof(UnitType) * CHAR_BIT,
                     typename std::enable_if<(UnitBits > CHAR_BIT), int>::type = 0>
            inline void reverse_bits(UnitType &unit) {
                boost::endian::endian_reverse_inplace(unit);
                UnitType out = UnitType();
                bit_in_unit_byte_reverser<UnitBits>::reverse(unit, out);
                unit = out;
            }
            template<typename UnitType,
                     int UnitBits = sizeof(UnitType) * CHAR_BIT,
                     typename std::enable_if<(UnitBits == CHAR_BIT), int>::type = 0>
            inline void reverse_bits(UnitType &unit) {
                reverse_byte(unit);
            }
 
            template<int InputBits, int UnitBits, int k = 0>
            struct bit_in_unit_reverser {
 
                BOOST_STATIC_ASSERT(!(InputBits % UnitBits) && !(UnitBits % CHAR_BIT));
 
                typedef bit_in_unit_reverser<InputBits, UnitBits, k + UnitBits> next_type;
                typedef typename boost::uint_t<UnitBits>::exact UnitType;
 
                template<typename ValueType>
                inline static void reverse(ValueType &in, ValueType &out) {
                    int const shift = InputBits - (UnitBits + k);
                    UnitType unit = UnitType(low_bits<UnitBits>(unbounded_shr(in, shift)));
                    reverse_bits(unit);
                    out |= unbounded_shl(low_bits<UnitBits>(ValueType(unit)), shift);
 
                    next_type::reverse(in, out);
                }
            };
 
            template<int InputBits, int UnitBits>
            struct bit_in_unit_reverser<InputBits, UnitBits, InputBits> {
                template<typename ValueType>
                inline static void reverse(ValueType &, ValueType &) {
                }
            };
 
            template<typename Endianness, int UnitBits>
            struct is_big_bit {
                constexpr static const bool value =
                    std::is_same<Endianness, stream_endian::big_unit_big_bit<UnitBits>>::value ||
                    std::is_same<Endianness, stream_endian::little_unit_big_bit<UnitBits>>::value;
            };
 
            template<typename Endianness, int UnitBits>
            struct is_little_bit {
                constexpr static const bool value =
                    std::is_same<Endianness, stream_endian::big_unit_little_bit<UnitBits>>::value ||
                    std::is_same<Endianness, stream_endian::little_unit_little_bit<UnitBits>>::value;
            };
 
            template<typename Endianness1, typename Endianness2, int UnitBits>
            struct is_same_bit {
                constexpr static const bool value =
                    (is_big_bit<Endianness1, UnitBits>::value && is_big_bit<Endianness2, UnitBits>::value) ||
                    (is_little_bit<Endianness1, UnitBits>::value && is_little_bit<Endianness2, UnitBits>::value);
            };
 
            template<typename InputEndianness,
                     typename OutputEndianness,
                     int UnitBits,
                     bool IsSameBit = is_same_bit<InputEndianness, OutputEndianness, UnitBits>::value>
            struct bit_reverser;
 
            template<typename InputEndianness, typename OutputEndianness, int UnitBits>
            struct bit_reverser<InputEndianness, OutputEndianness, UnitBits, true> {
                template<typename ValueType>
                inline static void reverse(ValueType &) {
                }
 
                template<typename ValueType>
                inline static ValueType reverse(ValueType const &val) {
                    return val;
                }
            };
 
            template<typename InputEndianness, typename OutputEndianness, int UnitBits>
            struct bit_reverser<InputEndianness, OutputEndianness, UnitBits, false> {
                template<typename ValueType, int ValueBits = sizeof(ValueType) * CHAR_BIT>
                inline static void reverse(ValueType &val) {
                    ValueType out = ValueType();
                    bit_in_unit_reverser<ValueBits, UnitBits>::reverse(val, out);
                    val = out;
                }
 
                template<typename ValueType, int ValueBits = sizeof(ValueType) * CHAR_BIT>
                inline static ValueType reverse(ValueType const &val) {
                    ValueType tmp = val;
                    ValueType out = ValueType();
                    bit_in_unit_reverser<ValueBits, UnitBits>::reverse(tmp, out);
                    return out;
                }
            };
 
            template<int InputBits, int UnitBits, int k = 0>
            struct byte_in_unit_reverser {
 
                BOOST_STATIC_ASSERT(!(InputBits % UnitBits) && !(UnitBits % CHAR_BIT));
 
                typedef byte_in_unit_reverser<InputBits, UnitBits, k + UnitBits> next_type;
                typedef typename boost::uint_t<UnitBits>::exact UnitType;
 
                template<typename ValueType>
                inline static void reverse(ValueType &in, ValueType &out) {
                    int const shift = InputBits - (UnitBits + k);
                    UnitType unit = UnitType(low_bits<UnitBits>(unbounded_shr(in, shift)));
                    boost::endian::endian_reverse_inplace(unit);
                    out |= unbounded_shl(low_bits<UnitBits>(ValueType(unit)), shift);
 
                    next_type::reverse(in, out);
                }
            };
 
            template<int InputBits, int UnitBits>
            struct byte_in_unit_reverser<InputBits, UnitBits, InputBits> {
                template<typename ValueType>
                inline static void reverse(ValueType &, ValueType &) {
                }
            };
 
            template<typename Endianness, int UnitBits>
            struct is_big_unit {
                constexpr static const bool value =
                    std::is_same<Endianness, stream_endian::big_unit_big_bit<UnitBits>>::value ||
                    std::is_same<Endianness, stream_endian::big_unit_little_bit<UnitBits>>::value;
            };
 
            template<typename Endianness, int UnitBits>
            struct is_little_unit {
                constexpr static const bool value =
                    std::is_same<Endianness, stream_endian::little_unit_big_bit<UnitBits>>::value ||
                    std::is_same<Endianness, stream_endian::little_unit_little_bit<UnitBits>>::value;
            };
 
            template<typename Endianness1, typename Endianness2, int UnitBits>
            struct is_same_unit {
                constexpr static const bool value =
                    (is_big_unit<Endianness1, UnitBits>::value && is_big_unit<Endianness2, UnitBits>::value) ||
                    (is_little_unit<Endianness1, UnitBits>::value && is_little_unit<Endianness2, UnitBits>::value);
            };
 
            template<typename InputEndianness, typename OutputEndianness, int UnitBits, typename Enable = void>
            struct unit_reverser;
 
            template<typename InputEndianness, typename OutputEndianness, int UnitBits>
            struct unit_reverser<
                InputEndianness,
                OutputEndianness,
                UnitBits,
                typename std::enable_if<is_same_unit<InputEndianness, OutputEndianness, UnitBits>::value>::type> {
                template<typename ValueType>
                inline static void reverse(ValueType &) {
                }
 
                template<typename ValueType>
                inline static ValueType reverse(ValueType const &val) {
                    return val;
                }
            };
 
            template<typename InputEndianness, typename OutputEndianness, int UnitBits>
            struct unit_reverser<
                InputEndianness,
                OutputEndianness,
                UnitBits,
                typename std::enable_if<!is_same_unit<InputEndianness, OutputEndianness, UnitBits>::value &&
                                        UnitBits == CHAR_BIT>::type> {
                template<typename ValueType>
                inline static void reverse(ValueType &val) {
                    boost::endian::endian_reverse_inplace(val);
                }
 
                template<typename ValueType>
                inline static ValueType reverse(ValueType const &val) {
                    return boost::endian::endian_reverse(val);
                }
            };
 
            template<typename InputEndianness, typename OutputEndianness, int UnitBits>
            struct unit_reverser<
                InputEndianness,
                OutputEndianness,
                UnitBits,
                typename std::enable_if<!is_same_unit<InputEndianness, OutputEndianness, UnitBits>::value &&
                                        (UnitBits > CHAR_BIT)>::type> {
                template<typename ValueType, int ValueBits = sizeof(ValueType) * CHAR_BIT>
                inline static void reverse(ValueType &val) {
                    boost::endian::endian_reverse_inplace(val);
                    ValueType out = ValueType();
                    byte_in_unit_reverser<ValueBits, UnitBits>::reverse(val, out);
                    val = out;
                }
 
                template<typename ValueType, int ValueBits = sizeof(ValueType) * CHAR_BIT>
                inline static ValueType reverse(ValueType const &val) {
                    ValueType tmp = boost::endian::endian_reverse(val);
                    ValueType out = ValueType();
                    byte_in_unit_reverser<ValueBits, UnitBits>::reverse(tmp, out);
                    return out;
                }
            };
        }    // namespace detail
    }        // namespace crypto3
}    // namespace nil
 
#endif    // CRYPTO3_DETAIL_REVERSER_HPP