base-v6.hpp

Go to the documentation of this file.

/**
 * @file      base-v6.hpp
 * @brief     Adds basic functionality for working with IPv6
 * @author    Vladimir Shaleev
 * @copyright MIT License
 * 
 * This file provides foundational classes and functions necessary for handling IPv6 addresses,
 * including parsing, constructing, and manipulating IPv6 address representations. It serves as
 * a base for higher-level IPv6 address operations and utilities.
 */
 
#ifndef IPADDRESS_BASE_V6_HPP
#define IPADDRESS_BASE_V6_HPP
 
#include "ipv4-address.hpp"
#include "uint128.hpp"
 
namespace IPADDRESS_NAMESPACE {
 
namespace internal {
 
IPADDRESS_NODISCARD IPADDRESS_CONSTEXPR IPADDRESS_FORCE_INLINE bool is_invalid_scope_id_symbol(char c) IPADDRESS_NOEXCEPT {
    return c == '%' || c == '/'
#ifndef IPADDRESS_SCOPE_ID_SUPPORT_SPACES
    || c == ' ' || (c >= '\t' && c <= '\r')
#endif // IPADDRESS_SCOPE_ID_SUPPORT_SPACES
    ;
}
 
} // namespace IPADDRESS_NAMESPACE::internal
 
/**
 * A template class providing the base functionality for IPv6 addresses.
 * 
 * This class encapsulates the basic properties and operations for IPv6 addresses,
 * such as version identification, size, and conversion from string representations.
 * It is intended to be extended by more specialized IPv6 address classes.
 * 
 * @tparam Ext The extension type that provides additional functionality.
 */
IPADDRESS_EXPORT template <typename Ext>
class base_v6 {
public:
    using base_type = byte_array<16>;
    using uint_type = ::IPADDRESS_NAMESPACE::uint128_t;
 
    static constexpr ip_version base_version = ip_version::V6;
    static constexpr size_t base_size = 16;
    static constexpr size_t base_max_string_len = 41 + IPADDRESS_IPV6_SCOPE_MAX_LENGTH;
    static constexpr size_t base_max_prefixlen = base_size * 8;
 
    /**
     * Retrieves the IP version of the address.
     * 
     * @return The IP version enumeration value for IPv6.
     */
    IPADDRESS_NODISCARD IPADDRESS_CONSTEXPR IPADDRESS_FORCE_INLINE ip_version version() const IPADDRESS_NOEXCEPT {
        return base_version;
    }
 
    /**
     * Retrieves the size of the IPv6 address.
     * 
     * @return The size of the IPv6 address in bytes.
     */
    IPADDRESS_NODISCARD IPADDRESS_CONSTEXPR IPADDRESS_FORCE_INLINE size_t size() const IPADDRESS_NOEXCEPT {
        return base_size;
    }
 
protected:
    static constexpr size_t _min_parts = 3;
    static constexpr size_t _max_parts = 8;
 
    template <typename Iter>
    IPADDRESS_NODISCARD static IPADDRESS_CONSTEXPR IPADDRESS_FORCE_INLINE ip_address_base<Ext> ip_from_string(Iter begin, Iter end, error_code& code, uint32_t& value) IPADDRESS_NOEXCEPT {
        if (begin == end) {
            code = error_code::empty_address;
            return {};
        }
 
        auto ip_and_scope = split_scope_id(begin, end, code, value);
 
        if (code != error_code::no_error) {
            return {};
        }
 
        const auto parts = split_parts(begin, ip_and_scope.end_ip, value, code);
 
        if (code != error_code::no_error) {
            return {};
        }
 
        const auto result = get_parts_bound(parts, value, code);
 
        if (code != error_code::no_error) {
            return {};
        }
 
        auto ip = ip_address_base<Ext>(parse_parts(parts, value, std::get<0>(result), std::get<1>(result), std::get<2>(result), code));
 
    #if IPADDRESS_IPV6_SCOPE_MAX_LENGTH > 0
        if (code != error_code::no_error) {
            return {};
        }
 
        if (ip_and_scope.scope_id[0] != '\0') {
            ip._data.scope_id = make_fixed_string(ip_and_scope.scope_id, code);
        }
    #endif // IPADDRESS_IPV6_SCOPE_MAX_LENGTH
 
        return ip;
    }
 
    IPADDRESS_NODISCARD static IPADDRESS_CONSTEXPR IPADDRESS_FORCE_INLINE ip_address_base<Ext> ip_from_prefix(size_t prefixlen) {
        base_type bytes {};
        for (size_t i = 0; i < (prefixlen >> 3); ++i) {
            bytes[i] = 0xFF;
        }
        auto shift = (prefixlen - ((prefixlen >> 3) << 3));
        if (shift > 0) {
            auto byte = 0xFF ^ uint8_t(uint8_t(0xFF) >> shift);
            bytes[prefixlen >> 3] = byte;
        }
        return ip_address_base<Ext>(bytes);
    }
 
    IPADDRESS_NODISCARD static IPADDRESS_CONSTEXPR IPADDRESS_FORCE_INLINE size_t ip_to_chars(const base_type& bytes, const fixed_string<IPADDRESS_IPV6_SCOPE_MAX_LENGTH>& scope_id, format fmt, char (&result)[base_max_string_len + 1]) IPADDRESS_NOEXCEPT {
        constexpr auto hextets_count = size_t(base_size >> 1);
        char hextets[hextets_count][5] = {};
        const size_t max_hextets = base_size >> 1;
        for (size_t i = 0; i < max_hextets; ++i) {
            const uint16_t value = (uint16_t(bytes[i * 2]) << 8) | uint16_t(bytes[i * 2 + 1]);
            to_hex(value, hextets[i]);
        }
 
        auto count = max_hextets;
        auto has_doublecolon_start = false;
        auto has_doublecolon_end = false;
 
        if (fmt == format::compact || fmt == format::compressed) {
            for (size_t i = 0; i < hextets_count; ++i) {
                auto& hextet = hextets[i];
                for (size_t h = 0; h < 3; ++h) {
                    if (hextet[0] != '0') {
                        break;
                    }
                    hextet[0] = hextet[1];
                    hextet[1] = hextet[2];
                    hextet[2] = hextet[3];
                    hextet[3] = hextet[4];
                }
            }
 
            if (fmt == format::compressed) {
                int best_doublecolon_len = 0;
                int best_doublecolon_start = -1;
                int doublecolon_len = 0;
                int doublecolon_start = -1;
 
                for (size_t i = 0; i < max_hextets; ++i) {
                    const auto& hextet = hextets[i];
                    if (hextet[0] == '0') {
                        doublecolon_len += 1;
 
                        if (doublecolon_start == -1) {
                            doublecolon_start = int(i);
                        }
                        if (doublecolon_len > best_doublecolon_len) {
                            best_doublecolon_len = doublecolon_len;
                            best_doublecolon_start = doublecolon_start;
                        }
                    } else {
                        doublecolon_len = 0;
                        doublecolon_start = -1;
                    }
                }
 
                if (best_doublecolon_len > 1) {
                    const int best_doublecolon_end = best_doublecolon_start + best_doublecolon_len;
                    if (best_doublecolon_end == max_hextets) {
                        has_doublecolon_end = true;
                    }
                    hextets[best_doublecolon_start][0] = '\0';
                    for (int h = best_doublecolon_start; h < max_hextets - 1; ++h) {
                        const auto lindex = h + 1;
                        const auto rindex = h + best_doublecolon_len;
                        if (rindex >= max_hextets) {
                            break;
                        }
                        hextets[lindex][0] = hextets[rindex][0];
                        hextets[lindex][1] = hextets[rindex][1];
                        hextets[lindex][2] = hextets[rindex][2];
                        hextets[lindex][3] = hextets[rindex][3];
                    }
                    count -= best_doublecolon_len - 1;
 
                    if (best_doublecolon_start == 0) {
                        has_doublecolon_start = true;
                    }
                }
            }
        }
 
        size_t offset = 0;
        if (has_doublecolon_start) {
            result[offset++] = ':';
        }
        for (size_t i = 0; i < count - 1; ++i) {
            const auto& hextet = hextets[i];
            for (size_t c = 0; hextet[c] != '\0'; ++c) {
                result[offset++] = hextet[c];
            }
            result[offset++] = ':';
        }
        const auto hextet = hextets[count - 1];
        for (size_t c = 0; hextet[c] != '\0'; ++c) {
            result[offset++] = hextet[c];
        }
        if (has_doublecolon_end) {
            result[offset++] = ':';
        }
        if (!scope_id.empty()) {
            result[offset++] = '%';
            const auto scope_id_size = scope_id.size();
            for (size_t i = 0; i < scope_id_size; ++i) {
                result[offset++] = scope_id[i];
            }
        }
        result[offset] = '\0';
        return offset;
    }
 
    IPADDRESS_NODISCARD static IPADDRESS_FORCE_INLINE std::string ip_reverse_pointer(const base_type& bytes) {
        char result[base_max_string_len + 1] {};
        const auto len = ip_to_chars(bytes, {}, format::full, result);
        auto ip = std::string(result, len);
        ip.erase(std::remove(ip.begin(), ip.end(), ':'), ip.end());
        auto res = std::accumulate(std::next(ip.rbegin()), ip.rend(), std::string{ip.back()}, [](std::string a, char b) {
            return std::move(a) + '.' + b;
        });
        return res + ".ip6.arpa";
    }
 
    template <typename Iter>
    IPADDRESS_NODISCARD static IPADDRESS_CONSTEXPR IPADDRESS_FORCE_INLINE std::tuple<ip_address_base<Ext>, size_t> parse_netmask(Iter begin, Iter end, error_code& code, uint32_t& code_value) IPADDRESS_NOEXCEPT {
        size_t prefixlen = 0;
        auto it = begin;
        auto has_prefixlen = false;
        while (it < end) {
            has_prefixlen = true;
            const auto c = internal::next_char_or_error(it, end, code, code_value);
            if (code != error_code::no_error) {
                return std::make_tuple(ip_address_base<Ext>(), 0);
            }
            if (c >= '0' && c <= '9') {
                prefixlen = prefixlen * 10 + (c - '0');
            } else {
                code = error_code::invalid_netmask;
                return std::make_tuple(ip_address_base<Ext>(), 0);
            }
        }
 
        if (prefixlen > base_max_prefixlen) {
            code = error_code::invalid_netmask;
            return std::make_tuple(ip_address_base<Ext>(), 0);
        }
 
        prefixlen = has_prefixlen ? prefixlen : base_max_prefixlen;
 
        auto netmask = ip_from_prefix(prefixlen);
        return std::make_tuple(netmask, prefixlen);
    }
 
    IPADDRESS_NODISCARD static IPADDRESS_CONSTEXPR IPADDRESS_FORCE_INLINE ip_address_base<Ext> strict_netmask(const ip_address_base<Ext>& address, const ip_address_base<Ext>& netmask, bool strict, error_code& code) IPADDRESS_NOEXCEPT {
        const auto& bytes_address = address.bytes();
        const auto& bytes_netmask = netmask.bytes();
        base_type bytes{};
 
        for (auto i = 0; i < base_size; ++i) {
            bytes[i] = bytes_address[i] & bytes_netmask[i];
        }
 
        if (bytes != bytes_address) {
            if (strict) {
                code = error_code::has_host_bits_set;
                return ip_address_base<Ext>();
            } else {
            #if IPADDRESS_IPV6_SCOPE_MAX_LENGTH > 0
                auto ip = ip_address_base<Ext>(bytes);
                if (address._data.scope_id[0] != '\0') {
                    ip._data.scope_id = address._data.scope_id;
                }
                return ip;
            #else // IPADDRESS_IPV6_SCOPE_MAX_LENGTH
                return ip_address_base<Ext>(bytes);
            #endif // IPADDRESS_IPV6_SCOPE_MAX_LENGTH
            }
        }
        return address;
    }
 
private:
    template <typename Iter>
    struct ip_and_scope {
        Iter end_ip;
        char scope_id[IPADDRESS_IPV6_SCOPE_MAX_LENGTH + 1];
    };
 
    template <typename Iter>
    IPADDRESS_NODISCARD static IPADDRESS_CONSTEXPR IPADDRESS_FORCE_INLINE ip_and_scope<Iter> split_scope_id(Iter begin, Iter end, error_code& error, uint32_t& error_value) IPADDRESS_NOEXCEPT {
    #if IPADDRESS_IPV6_SCOPE_MAX_LENGTH > 0
        auto index = 0;
    #endif // IPADDRESS_IPV6_SCOPE_MAX_LENGTH
        auto it = begin;
        auto scope = false;
        ip_and_scope<Iter> result{};
        while (it < end) {
            const auto c = internal::next_char_or_error(it, end, error, error_value);
            if (error != error_code::no_error) {
                return result;
            }
            if (!scope && c != '%') {
                result.end_ip = it;
            } else if (scope) {
            #if IPADDRESS_IPV6_SCOPE_MAX_LENGTH > 0
                if (index > IPADDRESS_IPV6_SCOPE_MAX_LENGTH - 1) {
                    error = error_code::scope_id_is_too_long;
                    return result;
                }
            #endif // IPADDRESS_IPV6_SCOPE_MAX_LENGTH
                if (internal::is_invalid_scope_id_symbol(c)) {
                    error = error_code::invalid_scope_id;
                    return result;
                }
            #if IPADDRESS_IPV6_SCOPE_MAX_LENGTH > 0
                result.scope_id[index++] = c;
            #endif // IPADDRESS_IPV6_SCOPE_MAX_LENGTH
            } else {
                scope = true;
            }
        }
    #if IPADDRESS_IPV6_SCOPE_MAX_LENGTH > 0
        if (scope && result.scope_id[0] == '\0') {
            error = error_code::invalid_scope_id;
            return result;
        }
    #endif // IPADDRESS_IPV6_SCOPE_MAX_LENGTH
        return result;
    }
 
    template <typename Iter>
    IPADDRESS_NODISCARD static IPADDRESS_CONSTEXPR IPADDRESS_FORCE_INLINE std::array<fixed_string<4>, _max_parts + 1> split_parts(Iter begin, Iter end, uint32_t& parts_count, error_code& error) IPADDRESS_NOEXCEPT {
        IPADDRESS_CONSTEXPR std::array<fixed_string<4>, _max_parts + 1> empty_parts = {
            make_fixed_string("\0\0\0\0"),
            make_fixed_string("\0\0\0\0"),
            make_fixed_string("\0\0\0\0"),
            make_fixed_string("\0\0\0\0"),
            make_fixed_string("\0\0\0\0"),
            make_fixed_string("\0\0\0\0"),
            make_fixed_string("\0\0\0\0"),
            make_fixed_string("\0\0\0\0"),
            make_fixed_string("\0\0\0\0")};
 
        char parts[_max_parts + 1][5] = {};
        char last_part[17] = {};
 
        parts_count = 0;
        int symbol = 0;
        char prev_c = '\0';
        bool has_double_colon = false;
 
        Iter it = begin;
        uint32_t error_symbol = 0;
 
        while (it < end) {
            auto c = internal::next_char_or_error(it, end, error, error_symbol);
            if (error != error_code::no_error) {
                parts_count = error_symbol;
                return empty_parts;
            }
            if (!has_double_colon && c == ':' && prev_c == ':') {
                has_double_colon = true;
            }
            if (parts_count > _max_parts) {
                error = has_double_colon
                    ? error_code::expected_at_most_7_other_parts_with_double_colon
                    : error_code::most_8_colons_permitted;
                return empty_parts;
            }
            if (c != ':') {
                if (symbol > 15) {
                    error = error_code::part_is_more_4_chars;
                    return empty_parts;
                }
                last_part[symbol++] = c;
                last_part[symbol] = '\0';
            } else {
                if (symbol > 4) {
                    error = error_code::part_is_more_4_chars;
                    return empty_parts;
                }
 
                auto& current_part = parts[parts_count++];
                current_part[0] = last_part[0];
                current_part[1] = last_part[1];
                current_part[2] = last_part[2];
                current_part[3] = last_part[3];
 
                symbol = 0;
                last_part[0] = '\0';
            }
            prev_c = c;
        }
 
        if (parts_count > _max_parts) {
            if (parts[0][0] == '\0' && parts[1][0] != '\0') {
                error = error_code::leading_colon_only_permitted_as_part_of_double_colon;
            } else if (last_part[0] == '\0') {
                error = error_code::trailing_colon_only_permitted_as_part_of_double_colon;
            } else {
                error = error_code::most_8_colons_permitted;
            }
            return empty_parts;
        }
 
        auto has_ipv4 = false;
 
        for (auto i = 0; i < symbol; ++i) {
            if (last_part[i] == '.') {
                has_ipv4 = true;
                break;
            }
        }
 
        if (has_ipv4) {
            if (parts_count + 1 >= _max_parts) {
                error = error_code::most_8_colons_permitted;
                return empty_parts;
            }
 
            auto ipv4 = ipv4_address::parse(last_part, error).to_uint();
 
            if (error != error_code::no_error) {
                return empty_parts;
            }
 
            to_hex(uint16_t((ipv4 >> 16) & 0xFFFF), parts[parts_count++]);
            to_hex(uint16_t(ipv4 & 0xFFFF), parts[parts_count++]);
        } else {
            if (symbol > 4) {
                error = error_code::part_is_more_4_chars;
                return empty_parts;
            }
 
            auto& current_part = parts[parts_count++];
            current_part[0] = last_part[0];
            current_part[1] = last_part[1];
            current_part[2] = last_part[2];
            current_part[3] = last_part[3];
        }
 
        if (parts_count < _min_parts) {
            error = error_code::least_3_parts;
            return empty_parts;
        }
 
        return {
            make_fixed_string(parts[0]),
            make_fixed_string(parts[1]),
            make_fixed_string(parts[2]),
            make_fixed_string(parts[3]),
            make_fixed_string(parts[4]),
            make_fixed_string(parts[5]),
            make_fixed_string(parts[6]),
            make_fixed_string(parts[7]),
            make_fixed_string(parts[8])};
    }
 
    IPADDRESS_NODISCARD static IPADDRESS_CONSTEXPR IPADDRESS_FORCE_INLINE std::tuple<size_t, size_t, size_t> get_parts_bound(const std::array<fixed_string<4>, _max_parts + 1>& parts, size_t parts_count, error_code& error) IPADDRESS_NOEXCEPT {
        size_t skip = 0;
        for (size_t i = 1; i < parts_count - 1; ++i) {
            if (parts[i].empty()) {
                if (skip) {
                    error = error_code::most_one_double_colon_permitted;
                    return { 0, 0, 0 };
                }
                skip = i;
            }
        }
 
        if (skip) {
            auto parts_hi = skip;
            auto parts_lo = parts_count - skip - 1;
 
            if (parts[0].empty()) {
                if (--parts_hi) {
                    error = error_code::leading_colon_only_permitted_as_part_of_double_colon;
                    return { 0, 0, 0 };
                }
            }
 
            if (parts[parts_count - 1].empty()) {
                if (--parts_lo) {
                    error = error_code::trailing_colon_only_permitted_as_part_of_double_colon;
                    return { 0, 0, 0 };
                }
            }
 
            const auto parts_skipped = _max_parts - (parts_hi + parts_lo);
 
            if (parts_skipped < 1) {
                error = error_code::expected_at_most_7_other_parts_with_double_colon;
                return { 0, 0, 0 };
            }
 
            return { parts_hi, parts_lo, parts_skipped };
        } else {
            if (parts_count != _max_parts) {
                error = error_code::exactly_8_parts_expected_without_double_colon;
                return { 0, 0, 0 };
            }
 
            if (parts[0].empty()) {
                error = error_code::leading_colon_only_permitted_as_part_of_double_colon;
                return { 0, 0, 0 };
            }
 
            if (parts[parts_count - 1].empty()) {
                error = error_code::trailing_colon_only_permitted_as_part_of_double_colon;
                return { 0, 0, 0 };
            }
 
            return { parts_count, 0, 0 };
        }
    }
 
    IPADDRESS_NODISCARD static IPADDRESS_CONSTEXPR IPADDRESS_FORCE_INLINE base_type parse_parts(const std::array<fixed_string<4>, _max_parts + 1>& parts, size_t parts_count, size_t hi, size_t lo, size_t skipped, error_code& error) IPADDRESS_NOEXCEPT {
        base_type result = {};
        size_t index = 0;
 
        for (size_t i = 0; i < hi; ++i) {
            const auto part = parse_part(parts[i], error);
            result[index++] = uint8_t(part >> 8);
            result[index++] = uint8_t(part & 0xFF);
 
            if (error != error_code::no_error) {
                return {};
            }
        }
        index += skipped << 1;
 
        assert(parts_count > lo);
        for (size_t i = parts_count - lo; i < parts_count; ++i) {
            const auto part = parse_part(parts[i], error);
            result[index++] = uint8_t(part >> 8);
            result[index++] = uint8_t(part & 0xFF);
 
            if (error != error_code::no_error) {
                return {};
            }
        }
        return result;
    }
 
    IPADDRESS_NODISCARD static IPADDRESS_CONSTEXPR IPADDRESS_FORCE_INLINE uint16_t parse_part(const fixed_string<4>& part, error_code& error) IPADDRESS_NOEXCEPT {
        uint16_t value = 0;
        for (size_t i = 0; i < part.size(); ++i) {
            const auto c = part[i];
            const auto power = pow16(part.size() - i - 1);
            if (c >= '0' && c <= '9') {
                value += (c - '0') * power;
            } else if(c >= 'A' && c <= 'F') {
                value += (c - 55) * power;
            } else if (c >= 'a' && c <= 'f') {
                value += (c - 87) * power;
            } else {
                error = error_code::part_has_invalid_symbol;
                return 0;
            }
        }
        return value;
    }
 
    IPADDRESS_NODISCARD static IPADDRESS_CONSTEXPR IPADDRESS_FORCE_INLINE uint16_t pow16(size_t power) IPADDRESS_NOEXCEPT {
        switch (power) {
            case 0: return 1;
            case 1: return 16;
            case 2: return 16 * 16;
            case 3: return 16 * 16 * 16;
            default:
                assert(!"Unreachable code");
                return 0;
        }
    }
 
    static IPADDRESS_CONSTEXPR IPADDRESS_FORCE_INLINE void to_hex(uint16_t value, char(&result)[5]) IPADDRESS_NOEXCEPT {
        constexpr char digits[] = "0123456789abcdef";
        for (auto i = 0, j = (4 - 1) * 4; i < 4; ++i, j -= 4) {
            result[i] = digits[(value >> j) & 0x0f];
            result[i + 1] = '\0';
        }
    }
};
 
template <typename Ext>
constexpr ip_version base_v6<Ext>::base_version;
 
template <typename Ext>
constexpr size_t base_v6<Ext>::base_size;
 
template <typename Ext>
constexpr size_t base_v6<Ext>::base_max_string_len;
 
template <typename Ext>
constexpr size_t base_v6<Ext>::base_max_prefixlen;
 
template <typename Ext>
constexpr size_t base_v6<Ext>::_min_parts;
 
template <typename Ext>
constexpr size_t base_v6<Ext>::_max_parts;
 
} // namespace IPADDRESS_NAMESPACE
 
#endif // IPADDRESS_BASE_V6_HPP