| // SPDX-License-Identifier: Apache-2.0 |
| // Copyright Network Geographics 2014 |
| /** @file |
| IP address range utilities. |
| */ |
| |
| #pragma once |
| |
| #include <swoc/DiscreteRange.h> |
| #include <swoc/IPAddr.h> |
| |
| namespace swoc { inline namespace SWOC_VERSION_NS { |
| |
| using ::std::string_view; |
| |
| class IP4Net; |
| class IP6Net; |
| class IPNet; |
| |
| namespace detail { |
| extern void *const pseudo_nullptr; |
| } |
| |
| /** An inclusive range of IPv4 addresses. |
| */ |
| class IP4Range : public DiscreteRange<IP4Addr> { |
| using self_type = IP4Range; |
| using super_type = DiscreteRange<IP4Addr>; |
| using metric_type = IP4Addr; |
| |
| public: |
| /// Default constructor, invalid range. |
| IP4Range() = default; |
| |
| /// Construct from an network expressed as @a addr and @a mask. |
| IP4Range(IP4Addr const &addr, IPMask const &mask); |
| |
| /// Construct from super type. |
| /// @internal Why do I have to do this, even though the super type constructors are inherited? |
| IP4Range(super_type const &r) : super_type(r) {} |
| |
| /** Construct range from @a text. |
| * |
| * @param text Range text. |
| * @see IP4Range::load |
| * |
| * This results in a zero address if @a text is not a valid string. If this should be checked, |
| * use @c load. |
| */ |
| IP4Range(string_view const &text); |
| |
| using super_type::super_type; ///< Import super class constructors. |
| |
| /** Set @a this range. |
| * |
| * @param addr Minimum address. |
| * @param mask CIDR mask to compute maximum adddress from @a addr. |
| * @return @a this |
| */ |
| self_type &assign(IP4Addr const &addr, IPMask const &mask); |
| |
| using super_type::assign; ///< Import assign methods. |
| |
| /** Assign to this range from text. |
| * |
| * @param text Range text. |
| * |
| * The text must be in one of three formats. |
| * - A dashed range, "addr1-addr2" |
| * - A singleton, "addr". This is treated as if it were "addr-addr", a range of size 1. |
| * - CIDR notation, "addr/cidr" where "cidr" is a number from 0 to the number of bits in the address. |
| */ |
| bool load(string_view text); |
| |
| /** Compute the mask for @a this as a network. |
| * |
| * @return If @a this is a network, the mask for that network. Otherwise an invalid mask. |
| * |
| * @see IPMask::is_valid |
| */ |
| IPMask network_mask() const; |
| |
| /// @return The range family. |
| sa_family_t family() const { return AF_INET; } |
| |
| class NetSource; |
| |
| /** Generate a list of networks covering @a this range. |
| * |
| * @return A network generator. |
| * |
| * The returned object can be used as an iterator, or as a container to iterating over |
| * the unique minimal set of networks that cover @a this range. |
| * |
| * @code |
| * void (IP4Range const& range) { |
| * for ( auto const& net : range ) { |
| * net.addr(); // network address. |
| * net.mask(); // network mask; |
| * } |
| * } |
| * @endcode |
| */ |
| NetSource networks() const; |
| }; |
| |
| /** Network generator class. |
| * This generates networks from a range and acts as both a forward iterator and a container. |
| * |
| * @see IP4Range::networks |
| */ |
| class IP4Range::NetSource { |
| using self_type = NetSource; ///< Self reference type. |
| public: |
| using range_type = IP4Range; ///< Import base range type. |
| |
| /// Construct from @a range. |
| explicit NetSource(range_type const &range); |
| |
| /// Copy constructor. |
| NetSource(self_type const &that) = default; |
| |
| /// This class acts as a container and an iterator. |
| using iterator = self_type; |
| /// All iteration is constant so no distinction between iterators. |
| using const_iterator = iterator; |
| |
| iterator begin() const; ///< First network. |
| static iterator end() ; ///< Past last network. |
| |
| /// Return @c true if there are valid networks, @c false if not. |
| bool empty() const; |
| |
| /// @return The current network. |
| IP4Net operator*() const; |
| |
| /// Access @a this as if it were an @c IP4Net. |
| self_type *operator->(); |
| |
| /// Iterator support. |
| /// @return The current network address. |
| IP4Addr const &addr() const; |
| |
| /// Iterator support. |
| /// @return The current network mask. |
| IPMask mask() const; |
| |
| /// Move to next network. |
| self_type &operator++(); |
| |
| /// Move to next network. |
| self_type operator++(int); |
| |
| /// Equality. |
| bool operator==(self_type const &that) const; |
| |
| /// Inequality. |
| bool operator!=(self_type const &that) const; |
| |
| protected: |
| IP4Range _range; ///< Remaining range. |
| /// Mask for current network. |
| IP4Addr _mask{~static_cast<in_addr_t>(0)}; |
| IPMask::raw_type _cidr = IP4Addr::WIDTH; ///< Current CIDR value. |
| |
| void search_wider(); |
| |
| void search_narrower(); |
| |
| bool is_valid(IP4Addr mask) const; |
| }; |
| |
| /// Inclusive range of IPv6 addresses. |
| class IP6Range : public DiscreteRange<IP6Addr> { |
| using self_type = IP6Range; |
| using super_type = DiscreteRange<IP6Addr>; |
| |
| public: |
| /// Construct from super type. |
| /// @internal Why do I have to do this, even though the super type constructors are inherited? |
| IP6Range(super_type const &r) : super_type(r) {} |
| |
| /** Construct range from @a text. |
| * |
| * @param text Range text. |
| * @see IP4Range::load |
| * |
| * This results in a zero address if @a text is not a valid string. If this should be checked, |
| * use @c load. |
| */ |
| IP6Range(string_view const &text); |
| |
| using super_type::super_type; ///< Import super class constructors. |
| |
| /** Set @a this range. |
| * |
| * @param addr Minimum address. |
| * @param mask CIDR mask to compute maximum adddress from @a addr. |
| * @return @a this |
| */ |
| self_type &assign(IP6Addr const &addr, IPMask const &mask); |
| |
| using super_type::assign; ///< Import assign methods. |
| |
| /** Assign to this range from text. |
| * |
| * @param text Range text. |
| * |
| * The text must be in one of three formats. |
| * - A dashed range, "addr1-addr2" |
| * - A singleton, "addr". This is treated as if it were "addr-addr", a range of size 1. |
| * - CIDR notation, "addr/cidr" where "cidr" is a number from 0 to the number of bits in the address. |
| */ |
| bool load(string_view text); |
| |
| /** Compute the mask for @a this as a network. |
| * |
| * @return If @a this is a network, the mask for that network. Otherwise an invalid mask. |
| * |
| * @see IPMask::is_valid |
| */ |
| IPMask network_mask() const; |
| |
| /// @return The range family. |
| sa_family_t family() const { return AF_INET6; } |
| |
| class NetSource; |
| |
| /** Generate a list of networks covering @a this range. |
| * |
| * @return A network generator. |
| * |
| * The returned object can be used as an iterator, or as a container to iterating over |
| * the unique minimal set of networks that cover @a this range. |
| * |
| * @code |
| * void (IP6Range const& range) { |
| * for ( auto const& net : range ) { |
| * net.addr(); // network address. |
| * net.mask(); // network mask; |
| * } |
| * } |
| * @endcode |
| */ |
| NetSource networks() const; |
| }; |
| |
| /** Network generator class. |
| * This generates networks from a range and acts as both a forward iterator and a container. |
| * |
| * @see IP6Range::networks |
| */ |
| class IP6Range::NetSource { |
| using self_type = NetSource; ///< Self reference type. |
| public: |
| using range_type = IP6Range; ///< Import base range type. |
| |
| /// Construct from @a range. |
| explicit NetSource(range_type const &range); |
| |
| /// Copy constructor. |
| NetSource(self_type const &that) = default; |
| |
| /// This class acts as a container and an iterator. |
| using iterator = self_type; |
| /// All iteration is constant so no distinction between iterators. |
| using const_iterator = iterator; |
| |
| iterator begin() const; ///< First network. |
| iterator end() const; ///< Past last network. |
| |
| /// @return @c true if there are valid networks, @c false if not. |
| bool empty() const; |
| |
| /// @return The current network. |
| IP6Net operator*() const; |
| |
| /// Access @a this as if it were an @c IP6Net. |
| self_type *operator->(); |
| |
| /// @return The current network address. |
| IP6Addr const & addr() const; |
| |
| /// Iterator support. |
| /// @return The current network mask. |
| IPMask mask() const; |
| |
| /// Move to next network. |
| self_type &operator++(); |
| |
| /// Move to next network. |
| self_type operator++(int); |
| |
| /// Equality. |
| bool operator==(self_type const &that) const; |
| |
| /// Inequality. |
| bool operator!=(self_type const &that) const; |
| |
| protected: |
| IP6Range _range; ///< Remaining range. |
| IPMask _mask{IP6Addr::WIDTH}; ///< Current CIDR value. |
| |
| void search_wider(); |
| |
| void search_narrower(); |
| |
| bool is_valid(IPMask const &mask); |
| }; |
| |
| /** Range of IP addresses. |
| * Although this can hold IPv4 or IPv6, any specific instance is one or the other, this can never contain |
| * a range of different address families. |
| */ |
| class IPRange { |
| using self_type = IPRange; |
| |
| public: |
| /// Default constructor - construct invalid range. |
| IPRange() = default; |
| |
| IPRange(IPAddr const &min, IPAddr const &max); |
| |
| /// Construct from an IPv4 @a range. |
| IPRange(IP4Range const &range); |
| |
| /// Construct from an IPv6 @a range. |
| IPRange(IP6Range const &range); |
| |
| /** Construct from a string format. |
| * |
| * @param text Text form of range. |
| * |
| * The string can be a single address, two addresses separated by a dash '-' or a CIDR network. |
| */ |
| IPRange(string_view const &text); |
| |
| /// Equality |
| bool |
| operator==(self_type const &that) const; |
| |
| /// @return @c true if this is an IPv4 range, @c false if not. |
| bool |
| is_ip4() const { |
| return AF_INET == _family; |
| } |
| |
| /// @return @c true if this is an IPv6 range, @c false if not. |
| bool |
| is_ip6() const { |
| return AF_INET6 == _family; |
| } |
| |
| /** Check if @a this range is the IP address @a family. |
| * |
| * @param family IP address family. |
| * @return @c true if this is @a family, @c false if not. |
| */ |
| bool is(sa_family_t family) const; |
| |
| /** Load the range from @a text. |
| * |
| * @param text Range specifier in text format. |
| * @return @c true if @a text was successfully parsed, @c false if not. |
| * |
| * A successful parse means @a this was loaded with the specified range. If not the range is |
| * marked as invalid. |
| */ |
| bool load(std::string_view const &text); |
| |
| /// @return The minimum address in the range. |
| IPAddr min() const; |
| |
| /// @return The maximum address in the range. |
| IPAddr max() const; |
| |
| /// @return @c true if there are no addresses in the range. |
| bool empty() const; |
| |
| /// @return The IPv4 range. |
| IP4Range const & ip4() const { return _range._ip4; } |
| |
| /// @return The IPv6 range. |
| IP6Range const & ip6() const { return _range._ip6; } |
| |
| /// @return The range family. |
| sa_family_t family() const { return _family; } |
| |
| /** Compute the mask for @a this as a network. |
| * |
| * @return If @a this is a network, the mask for that network. Otherwise an invalid mask. |
| * |
| * @see IPMask::is_valid |
| */ |
| IPMask network_mask() const; |
| |
| class NetSource; |
| |
| /** Generate a list of networks covering @a this range. |
| * |
| * @return A network generator. |
| * |
| * The returned object can be used as an iterator, or as a container to iterating over |
| * the unique minimal set of networks that cover @a this range. |
| * |
| * @code |
| * void (IPRange const& range) { |
| * for ( auto const& net : range ) { |
| * net.addr(); // network address. |
| * net.mask(); // network mask; |
| * } |
| * } |
| * @endcode |
| */ |
| NetSource networks() const; |
| |
| protected: |
| /** Range container. |
| * |
| * @internal |
| * |
| * This was a @c std::variant at one point, but the complexity got in the way because |
| * - These objects have no state, need no destruction. |
| * - Construction was problematic because @c variant requires construction, then access, |
| * whereas this needs access to construct (e.g. via the @c load method). |
| */ |
| union { |
| std::monostate _nil; ///< Make constructor easier to implement. |
| IP4Range _ip4; ///< IPv4 range. |
| IP6Range _ip6; ///< IPv6 range. |
| } _range{std::monostate{}}; |
| /// Family of @a _range. |
| sa_family_t _family{AF_UNSPEC}; |
| }; |
| |
| /** Network generator class. |
| * This generates networks from a range and acts as both a forward iterator and a container. |
| * |
| * @see IPRange::networks |
| */ |
| class IPRange::NetSource { |
| using self_type = NetSource; ///< Self reference type. |
| public: |
| using range_type = IPRange; ///< Import base range type. |
| |
| /// Construct from @a range. |
| explicit NetSource(range_type const &range); |
| |
| /// Copy constructor. |
| NetSource(self_type const &that) = default; |
| |
| /// This class acts as a container and an iterator. |
| using iterator = self_type; |
| /// All iteration is constant so no distinction between iterators. |
| using const_iterator = iterator; |
| |
| iterator begin() const; ///< First network. |
| iterator end() const; ///< Past last network. |
| |
| /// @return The current network. |
| IPNet operator*() const; |
| |
| /// Access @a this as if it were an @c IP6Net. |
| self_type *operator->(); |
| |
| /// Iterator support. |
| /// @return The current network address. |
| IPAddr addr() const; |
| |
| /// Iterator support. |
| /// @return The current network mask. |
| IPMask mask() const; |
| |
| /// Move to next network. |
| self_type &operator++(); |
| |
| /// Move to next network. |
| self_type operator++(int); |
| |
| /// Equality. |
| bool operator==(self_type const &that) const; |
| |
| /// Inequality. |
| bool operator!=(self_type const &that) const; |
| |
| protected: |
| union { |
| std::monostate _nil; ///< Default value, no addresses. |
| IP4Range::NetSource _ip4; ///< IPv4 addresses. |
| IP6Range::NetSource _ip6; ///< IPv6 addresses. |
| }; |
| sa_family_t _family = AF_UNSPEC; ///< Mark for union content. |
| }; |
| |
| /// An IPv4 network. |
| class IP4Net { |
| using self_type = IP4Net; ///< Self reference type. |
| public: |
| IP4Net() = default; ///< Construct invalid network. |
| IP4Net(self_type const &that) = default; ///< Copy constructor. |
| |
| /** Construct from @a addr and @a mask. |
| * |
| * @param addr An address in the network. |
| * @param mask The mask for the network. |
| * |
| * The network is based on the mask, and the resulting network address is chosen such that the |
| * network will contain @a addr. For a given @a addr and @a mask there is only one network |
| * that satisifies these criteria. |
| */ |
| IP4Net(IP4Addr addr, IPMask mask); |
| |
| IP4Net(swoc::TextView text) { this->load(text); } |
| |
| /** Parse network as @a text. |
| * |
| * @param text String describing the network in CIDR format. |
| * @return @c true if a valid string, @c false if not. |
| */ |
| bool load(swoc::TextView text); |
| |
| /// @return @c true if the network is valid, @c false if not. |
| bool is_valid() const; |
| |
| /// @return THh smallest address in the network. |
| IP4Addr lower_bound() const; |
| |
| /// @return The largest address in the network. |
| IP4Addr upper_bound() const; |
| |
| /// @return The mask for the network. |
| IPMask const &mask() const; |
| |
| /// @return A range that exactly covers the network. |
| IP4Range as_range() const; |
| |
| /** Assign an @a addr and @a mask to @a this. |
| * |
| * @param addr Network addres. |
| * @param mask Network mask. |
| * @return @a this. |
| */ |
| self_type &assign(IP4Addr const &addr, IPMask const &mask); |
| |
| /// Reset network to invalid state. |
| self_type & clear() { _mask.clear(); return *this; } |
| |
| /// Equality. |
| bool operator==(self_type const &that) const; |
| |
| /// Inequality |
| bool operator!=(self_type const &that) const; |
| |
| protected: |
| IP4Addr _addr; ///< Network address (also lower_bound). |
| IPMask _mask; ///< Network mask. |
| }; |
| |
| /// IPv6 network. |
| class IP6Net { |
| using self_type = IP6Net; ///< Self reference type. |
| public: |
| IP6Net() = default; ///< Construct invalid network. |
| IP6Net(self_type const &that) = default; ///< Copy constructor. |
| |
| /** Construct from @a addr and @a mask. |
| * |
| * @param addr An address in the network. |
| * @param mask The mask for the network. |
| * |
| * The network is based on the mask, and the resulting network address is chosen such that the |
| * network will contain @a addr. For a given @a addr and @a mask there is only one network |
| * that satisifies these criteria. |
| */ |
| IP6Net(IP6Addr addr, IPMask mask); |
| |
| /** Parse network as @a text. |
| * |
| * @param text String describing the network in CIDR format. |
| * @return @c true if a valid string, @c false if not. |
| */ |
| bool load(swoc::TextView text); |
| |
| /// @return @c true if the network is valid, @c false if not. |
| bool is_valid() const; |
| |
| /// @return THh smallest address in the network. |
| IP6Addr lower_bound() const; |
| |
| /// @return The largest address in the network. |
| IP6Addr upper_bound() const; |
| |
| /// @return The mask for the network. |
| IPMask const &mask() const; |
| |
| /// @return A range that exactly covers the network. |
| IP6Range as_range() const; |
| |
| /** Assign an @a addr and @a mask to @a this. |
| * |
| * @param addr Network addres. |
| * @param mask Network mask. |
| * @return @a this. |
| */ |
| self_type &assign(IP6Addr const &addr, IPMask const &mask); |
| |
| /// Reset network to invalid state. |
| self_type & |
| clear() { |
| _mask.clear(); |
| return *this; |
| } |
| |
| /// Equality. |
| bool operator==(self_type const &that) const; |
| |
| /// Inequality |
| bool operator!=(self_type const &that) const; |
| |
| protected: |
| IP6Addr _addr; ///< Network address (also lower_bound). |
| IPMask _mask; ///< Network mask. |
| }; |
| |
| /** Representation of an IP address network. |
| * |
| */ |
| class IPNet { |
| using self_type = IPNet; ///< Self reference type. |
| public: |
| IPNet() = default; ///< Construct invalid network. |
| IPNet(self_type const &that) = default; ///< Copy constructor. |
| |
| /** Construct from @a addr and @a mask. |
| * |
| * @param addr An address in the network. |
| * @param mask The mask for the network. |
| * |
| * The network is based on the mask, and the resulting network address is chosen such that the |
| * network will contain @a addr. For a given @a addr and @a mask there is only one network |
| * that satisifies these criteria. |
| */ |
| IPNet(IPAddr const &addr, IPMask const &mask); |
| |
| IPNet(TextView text); |
| |
| /** Parse network as @a text. |
| * |
| * @param text String describing the network in CIDR format. |
| * @return @c true if a valid string, @c false if not. |
| */ |
| bool load(swoc::TextView text); |
| |
| /// @return @c true if the network is valid, @c false if not. |
| bool is_valid() const; |
| |
| /// @return THh smallest address in the network. |
| IPAddr lower_bound() const; |
| |
| /// @return The largest address in the network. |
| IPAddr upper_bound() const; |
| |
| IPMask::raw_type width() const; |
| |
| /// @return The mask for the network. |
| IPMask const &mask() const; |
| |
| /// @return A range that exactly covers the network. |
| IPRange as_range() const; |
| |
| bool is_ip4() const { return _addr.is_ip4(); } |
| |
| bool is_ip6() const { return _addr.is_ip6(); } |
| |
| sa_family_t family() const { return _addr.family(); } |
| |
| IP4Net |
| ip4() const { |
| return IP4Net{_addr.ip4(), _mask}; |
| } |
| |
| IP6Net |
| ip6() const { |
| return IP6Net{_addr.ip6(), _mask}; |
| } |
| |
| /** Assign an @a addr and @a mask to @a this. |
| * |
| * @param addr Network addres. |
| * @param mask Network mask. |
| * @return @a this. |
| */ |
| self_type &assign(IPAddr const &addr, IPMask const &mask); |
| |
| /// Reset network to invalid state. |
| self_type & |
| clear() { |
| _mask.clear(); |
| return *this; |
| } |
| |
| /// Equality. |
| bool operator==(self_type const &that) const; |
| |
| /// Inequality |
| bool operator!=(self_type const &that) const; |
| |
| protected: |
| IPAddr _addr; ///< Address and family. |
| IPMask _mask; ///< Network mask. |
| }; |
| |
| // -------------------------------------------------------------------------- |
| /** Coloring of IP address space. |
| * |
| * @tparam PAYLOAD The color class. |
| * |
| * This is a class to do fast coloring and lookup of the IP address space. It is range oriented and |
| * performs well for ranges, much less well for singletons. Conceptually every IP address is a key |
| * in the space and can have a color / payload of type @c PAYLOAD. |
| * |
| * @c PAYLOAD must have the properties |
| * |
| * - Cheap to copy. |
| * - Comparable via the equality and inequality operators. |
| */ |
| template <typename PAYLOAD> class IPSpace { |
| using self_type = IPSpace; |
| using IP4Space = DiscreteSpace<IP4Addr, PAYLOAD>; |
| using IP6Space = DiscreteSpace<IP6Addr, PAYLOAD>; |
| |
| public: |
| using payload_t = PAYLOAD; ///< Export payload type. |
| using value_type = std::tuple<IPRange const, PAYLOAD &>; |
| |
| /// Construct an empty space. |
| IPSpace() = default; |
| |
| /** Mark the range @a r with @a payload. |
| * |
| * @param range Range to mark. |
| * @param payload Payload to assign. |
| * @return @a this |
| * |
| * All addresses in @a r are set to have the @a payload. |
| */ |
| self_type &mark(IPRange const &range, PAYLOAD const &payload); |
| |
| /** Fill the @a range with @a payload. |
| * |
| * @param range Destination range. |
| * @param payload Payload for range. |
| * @return this |
| * |
| * Addresses in @a range are set to have @a payload if the address does not already have a payload. |
| */ |
| self_type &fill(IPRange const &range, PAYLOAD const &payload); |
| |
| /** Erase addresses in @a range. |
| * |
| * @param range Address range. |
| * @return @a this |
| */ |
| self_type &erase(IPRange const &range); |
| |
| /** Blend @a color in to the @a range. |
| * |
| * @tparam F Blending functor type (deduced). |
| * @tparam U Data to blend in to payloads. |
| * @param range Target range. |
| * @param color Data to blend in to existing payloads in @a range. |
| * @param blender Blending functor. |
| * @return @a this |
| * |
| * @a blender is required to have the signature <tt>void(PAYLOAD& lhs , U CONST&rhs)</tt>. It must |
| * act as a compound assignment operator, blending @a rhs into @a lhs. That is, if the result of |
| * blending @a rhs in to @a lhs is defined as "lhs @ rhs" for the binary operator "@", then @a |
| * blender computes "lhs @= rhs". |
| * |
| * Every address in @a range is assigned a payload. If the address does not already have a color, |
| * it is assigned the default constructed @c PAYLOAD blended with @a color. If the address has a |
| * @c PAYLOAD @a p, @a p is updated by invoking <tt>blender(p, color)</tt>, with the expectation |
| * that @a p will be updated in place. |
| */ |
| template <typename F, typename U = PAYLOAD> self_type &blend(IPRange const &range, U const &color, F &&blender); |
| |
| template <typename F, typename U = PAYLOAD> |
| self_type & blend(IP4Range const &range, U const &color, F &&blender); |
| |
| template <typename F, typename U = PAYLOAD> |
| self_type & |
| blend(IP6Range const &range, U const &color, F &&blender); |
| |
| /// @return The number of distinct ranges. |
| size_t |
| count() const { |
| return _ip4.count() + _ip6.count(); |
| } |
| |
| size_t |
| count_ip4() const { |
| return _ip4.count(); |
| } |
| size_t |
| count_ip6() const { |
| return _ip6.count(); |
| } |
| |
| size_t count(sa_family_t f) const; |
| |
| /// Remove all ranges. |
| void clear(); |
| |
| /** Constant iterator. |
| * The value type is a tuple of the IP address range and the @a PAYLOAD. Both are constant. |
| * |
| * @internal The non-const iterator is a subclass of this, in order to share implementation. This |
| * also makes it easy to convert from iterator to const iterator, which is desirable. |
| * |
| * @internal The return type is quite tricky because the value type of the nested containers is |
| * not the same as the value type for this container. It's not even a composite - @c IPRange is |
| * not an alias for either of the family specific range types. Therefore the iterator itself must |
| * contain a synthesized instance of the value type, which creates scoping and update problems. |
| * The approach here is to update the synthetic value when the iterator is modified and returning |
| * it by value for the dereference operator because a return by reference means code like |
| * @code |
| * auto && [ r , p ] = *(space.find(addr)); |
| * @endcode |
| * can fail due to the iterator going out of scope after the statement is finished making @a r |
| * and @a p dangling references. If the return is by value the compiler takes care of it. |
| */ |
| class const_iterator { |
| using self_type = const_iterator; ///< Self reference type. |
| friend class IPSpace; |
| |
| public: |
| using value_type = std::tuple<IPRange const, PAYLOAD const &>; /// Import for API compliance. |
| // STL algorithm compliance. |
| using iterator_category = std::bidirectional_iterator_tag; |
| using pointer = value_type *; |
| using reference = value_type &; |
| using difference_type = int; |
| |
| /// Default constructor. |
| const_iterator() = default; |
| |
| /// Copy constructor. |
| const_iterator(self_type const &that); |
| |
| /// Assignment. |
| self_type &operator=(self_type const &that); |
| |
| /// Pre-increment. |
| /// Move to the next element in the list. |
| /// @return The iterator. |
| self_type &operator++(); |
| |
| /// Pre-decrement. |
| /// Move to the previous element in the list. |
| /// @return The iterator. |
| self_type &operator--(); |
| |
| /// Post-increment. |
| /// Move to the next element in the list. |
| /// @return The iterator value before the increment. |
| self_type operator++(int); |
| |
| /// Post-decrement. |
| /// Move to the previous element in the list. |
| /// @return The iterator value before the decrement. |
| self_type operator--(int); |
| |
| /// Dereference. |
| /// @return A reference to the referent. |
| value_type operator*() const; |
| |
| /// Dereference. |
| /// @return A pointer to the referent. |
| value_type const *operator->() const; |
| |
| /// Equality |
| bool operator==(self_type const &that) const; |
| |
| /// Inequality |
| bool operator!=(self_type const &that) const; |
| |
| protected: |
| // These are stored non-const to make implementing @c iterator easier. The containing class provides the |
| // required @c const protection. Internally a tuple of iterators is stored for forward iteration. If |
| // the primary (ipv4) iterator is at the end, then use the secondary (ipv6) iterator. The reverse |
| // is done for reverse iteration. This depends on the extra support @c IntrusiveDList iterators |
| // provide. |
| typename IP4Space::iterator _iter_4; ///< IPv4 sub-space iterator. |
| typename IP6Space::iterator _iter_6; ///< IPv6 sub-space iterator. |
| /// Current value. |
| value_type _value{IPRange{}, *static_cast<PAYLOAD *>(detail::pseudo_nullptr)}; |
| |
| /** Internal constructor. |
| * |
| * @param iter4 Starting place for IPv4 subspace. |
| * @param iter6 Starting place for IPv6 subspace. |
| * |
| * In practice, at most one iterator should be "internal", the other should be the beginning or end. |
| */ |
| const_iterator(typename IP4Space::iterator const &iter4, typename IP6Space::iterator const &iter6); |
| }; |
| |
| /** Iterator. |
| * The value type is a tuple of the IP address range and the @a PAYLOAD. The range is constant |
| * and the @a PAYLOAD is a reference. This can be used to update the @a PAYLOAD for this range. |
| * |
| * @note Range merges are not trigged by modifications of the @a PAYLOAD via an iterator. |
| */ |
| class iterator : public const_iterator { |
| using self_type = iterator; |
| using super_type = const_iterator; |
| |
| friend class IPSpace; |
| |
| protected: |
| using super_type::super_type; /// Inherit supertype constructors. |
| /// Protected constructor to convert const to non-const. |
| /// @note This makes for much less code duplication in iterator relevant methods. |
| iterator(const_iterator const& that) : const_iterator(that) {} |
| public: |
| /// Value type of iteration. |
| using value_type = std::tuple<IPRange const, PAYLOAD &>; |
| using pointer = value_type *; |
| using reference = value_type &; |
| |
| /// Default constructor. |
| iterator() = default; |
| |
| /// Copy constructor. |
| iterator(self_type const &that); |
| |
| /// Assignment. |
| self_type &operator=(self_type const &that); |
| |
| /// Pre-increment. |
| /// Move to the next element in the list. |
| /// @return The iterator. |
| self_type &operator++(); |
| |
| /// Pre-decrement. |
| /// Move to the previous element in the list. |
| /// @return The iterator. |
| self_type &operator--(); |
| |
| /// Post-increment. |
| /// Move to the next element in the list. |
| /// @return The iterator value before the increment. |
| self_type |
| operator++(int) { |
| self_type zret{*this}; |
| ++*this; |
| return zret; |
| } |
| |
| /// Post-decrement. |
| /// Move to the previous element in the list. |
| /// @return The iterator value before the decrement. |
| self_type |
| operator--(int) { |
| self_type zret{*this}; |
| --*this; |
| return zret; |
| } |
| |
| /// Dereference. |
| /// @return A reference to the referent. |
| value_type operator*() const; |
| |
| /// Dereference. |
| /// @return A pointer to the referent. |
| value_type const *operator->() const; |
| }; |
| |
| /** Find the payload for an @a addr. |
| * |
| * @param addr Address to find. |
| * @return Iterator for the range containing @a addr. |
| */ |
| iterator find(IPAddr const &addr); |
| |
| /** Find the payload for an @a addr. |
| * |
| * @param addr Address to find. |
| * @return Iterator for the range containing @a addr. |
| */ |
| const_iterator find(IPAddr const &addr) const; |
| |
| /** Find the payload for an @a addr. |
| * |
| * @param addr Address to find. |
| * @return An iterator which is valid if @a addr was found, @c end if not. |
| */ |
| iterator find(IP4Addr const &addr); |
| |
| /** Find the payload for an @a addr. |
| * |
| * @param addr Address to find. |
| * @return An iterator which is valid if @a addr was found, @c end if not. |
| */ |
| const_iterator find(IP4Addr const &addr) const; |
| |
| /** Find the payload for an @a addr. |
| * |
| * @param addr Address to find. |
| * @return An iterator which is valid if @a addr was found, @c end if not. |
| */ |
| iterator find(IP6Addr const &addr); |
| |
| /** Find the payload for an @a addr. |
| * |
| * @param addr Address to find. |
| * @return An iterator which is valid if @a addr was found, @c end if not. |
| */ |
| const_iterator find(IP6Addr const &addr) const; |
| |
| /// @return An iterator to the first element. |
| iterator begin(); |
| |
| /// @return A constant iterator to the first element. |
| const_iterator begin() const; |
| |
| /// @return An iterator past the last element. |
| iterator end(); |
| |
| /// @return A constant iterator past the last element. |
| const_iterator end() const; |
| |
| /// @return Iterator to the first IPv4 address. |
| iterator begin_ip4(); |
| /// @return Iterator to the first IPv4 address. |
| const_iterator begin_ip4() const; |
| |
| /// @return Iterator past the last IPv4 address. |
| iterator end_ip4(); |
| /// @return Iterator past the last IPv4 address. |
| const_iterator end_ip4() const; |
| |
| /// @return Iterator at the first IPv6 address. |
| iterator begin_ip6(); |
| /// @return Iterator at the first IPv6 address. |
| const_iterator begin_ip6() const; |
| /// @return Iterator past the last IPv6 address. |
| iterator end_ip6(); |
| /// @return Iterator past the last IPv6 address. |
| const_iterator end_ip6() const; |
| |
| /// @return Iterator to the first address of @a family. |
| const_iterator begin(sa_family_t family) const; |
| |
| /// @return Iterator past the last address of @a family. |
| const_iterator |
| end(sa_family_t family) const; |
| |
| protected: |
| IP4Space _ip4; ///< Sub-space containing IPv4 ranges. |
| IP6Space _ip6; ///< sub-space containing IPv6 ranges. |
| }; |
| |
| template <typename PAYLOAD> |
| IPSpace<PAYLOAD>::const_iterator::const_iterator(typename IP4Space::iterator const &iter4, typename IP6Space::iterator const &iter6) |
| : _iter_4(iter4), _iter_6(iter6) { |
| if (_iter_4.has_next()) { |
| new (&_value) value_type{_iter_4->range(), _iter_4->payload()}; |
| } else if (_iter_6.has_next()) { |
| new (&_value) value_type{_iter_6->range(), _iter_6->payload()}; |
| } |
| } |
| |
| template <typename PAYLOAD> IPSpace<PAYLOAD>::const_iterator::const_iterator(self_type const &that) { |
| *this = that; |
| } |
| |
| template <typename PAYLOAD> |
| auto |
| IPSpace<PAYLOAD>::const_iterator::operator=(self_type const &that) -> self_type & { |
| _iter_4 = that._iter_4; |
| _iter_6 = that._iter_6; |
| new (&_value) value_type{that._value}; |
| return *this; |
| } |
| |
| template <typename PAYLOAD> |
| auto |
| IPSpace<PAYLOAD>::const_iterator::operator++() -> self_type & { |
| bool incr_p = false; |
| if (_iter_4.has_next()) { |
| ++_iter_4; |
| incr_p = true; |
| if (_iter_4.has_next()) { |
| new (&_value) value_type{_iter_4->range(), _iter_4->payload()}; |
| return *this; |
| } |
| } |
| |
| if (_iter_6.has_next()) { |
| if (incr_p || (++_iter_6).has_next()) { |
| new (&_value) value_type{_iter_6->range(), _iter_6->payload()}; |
| return *this; |
| } |
| } |
| new (&_value) value_type{IPRange{}, *static_cast<PAYLOAD *>(detail::pseudo_nullptr)}; |
| return *this; |
| } |
| |
| template <typename PAYLOAD> |
| auto |
| IPSpace<PAYLOAD>::const_iterator::operator++(int) -> self_type { |
| self_type zret(*this); |
| ++*this; |
| return zret; |
| } |
| |
| template <typename PAYLOAD> |
| auto |
| IPSpace<PAYLOAD>::const_iterator::operator--() -> self_type & { |
| if (_iter_6.has_prev()) { |
| --_iter_6; |
| new (&_value) value_type{_iter_6->range(), _iter_6->payload()}; |
| return *this; |
| } |
| if (_iter_4.has_prev()) { |
| --_iter_4; |
| new (&_value) value_type{_iter_4->range(), _iter_4->payload()}; |
| return *this; |
| } |
| new (&_value) value_type{IPRange{}, *static_cast<PAYLOAD *>(detail::pseudo_nullptr)}; |
| return *this; |
| } |
| |
| template <typename PAYLOAD> |
| auto |
| IPSpace<PAYLOAD>::const_iterator::operator--(int) -> self_type { |
| self_type zret(*this); |
| --*this; |
| return zret; |
| } |
| |
| template <typename PAYLOAD> |
| auto |
| IPSpace<PAYLOAD>::const_iterator::operator*() const -> value_type { |
| return _value; |
| } |
| |
| template <typename PAYLOAD> |
| auto |
| IPSpace<PAYLOAD>::const_iterator::operator->() const -> value_type const * { |
| return &_value; |
| } |
| |
| /* Bit of subtlety with equality - although it seems that if @a _iter_4 is valid, it doesn't matter |
| * where @a _iter6 is (because it is really the iterator location that's being checked), it's |
| * neccesary to do the @a _iter_4 validity on both iterators to avoid the case of a false positive |
| * where different internal iterators are valid. However, in practice the other (non-active) |
| * iterator won't have an arbitrary value, it will be either @c begin or @c end in step with the |
| * active iterator therefore it's effective and cheaper to just check both values. |
| */ |
| |
| template <typename PAYLOAD> |
| bool |
| IPSpace<PAYLOAD>::const_iterator::operator==(self_type const &that) const { |
| return _iter_4 == that._iter_4 && _iter_6 == that._iter_6; |
| } |
| |
| template <typename PAYLOAD> |
| bool |
| IPSpace<PAYLOAD>::const_iterator::operator!=(self_type const &that) const { |
| return _iter_4 != that._iter_4 || _iter_6 != that._iter_6; |
| } |
| |
| template <typename PAYLOAD> IPSpace<PAYLOAD>::iterator::iterator(self_type const &that) { |
| *this = that; |
| } |
| |
| template <typename PAYLOAD> |
| auto |
| IPSpace<PAYLOAD>::iterator::operator=(self_type const &that) -> self_type & { |
| this->super_type::operator=(that); |
| return *this; |
| } |
| |
| template <typename PAYLOAD> |
| auto |
| IPSpace<PAYLOAD>::iterator::operator->() const -> value_type const * { |
| return static_cast<value_type *>(&super_type::_value); |
| } |
| |
| template <typename PAYLOAD> |
| auto |
| IPSpace<PAYLOAD>::iterator::operator*() const -> value_type { |
| return reinterpret_cast<value_type const &>(super_type::_value); |
| } |
| |
| template <typename PAYLOAD> |
| auto |
| IPSpace<PAYLOAD>::iterator::operator++() -> self_type & { |
| this->super_type::operator++(); |
| return *this; |
| } |
| |
| template <typename PAYLOAD> |
| auto |
| IPSpace<PAYLOAD>::iterator::operator--() -> self_type & { |
| this->super_type::operator--(); |
| return *this; |
| } |
| |
| // -------------------------------------------------------------------------- |
| /// ------------------------------------------------------------------------------------ |
| |
| // +++ IPRange +++ |
| |
| inline IP4Range::IP4Range(string_view const &text) { |
| this->load(text); |
| } |
| |
| inline auto |
| IP4Range::networks() const -> NetSource { |
| return {NetSource{*this}}; |
| } |
| |
| inline IP6Range::IP6Range(string_view const &text) { |
| this->load(text); |
| } |
| |
| inline auto |
| IP6Range::networks() const -> NetSource { |
| return {NetSource{*this}}; |
| } |
| |
| inline IPRange::IPRange(IP4Range const &range) : _family(AF_INET) { |
| _range._ip4 = range; |
| } |
| |
| inline IPRange::IPRange(IP6Range const &range) : _family(AF_INET6) { |
| _range._ip6 = range; |
| } |
| |
| inline IPRange::IPRange(string_view const &text) { |
| this->load(text); |
| } |
| |
| inline auto |
| IPRange::networks() const -> NetSource { |
| return {NetSource{*this}}; |
| } |
| |
| inline bool |
| IPRange::is(sa_family_t family) const { |
| return family == _family; |
| } |
| |
| // +++ IPNet +++ |
| |
| inline IP4Net::IP4Net(swoc::IP4Addr addr, swoc::IPMask mask) : _addr(addr & mask), _mask(mask) {} |
| |
| inline IPMask const & |
| IP4Net::mask() const { |
| return _mask; |
| } |
| |
| inline bool |
| IP4Net::is_valid() const { |
| return _mask.is_valid(); |
| } |
| |
| inline IP4Addr |
| IP4Net::lower_bound() const { |
| return _addr; |
| } |
| |
| inline IP4Addr |
| IP4Net::upper_bound() const { |
| return _addr | _mask; |
| } |
| |
| inline IP4Range |
| IP4Net::as_range() const { |
| return {this->lower_bound(), this->upper_bound()}; |
| } |
| |
| inline bool |
| IP4Net::operator==(self_type const &that) const { |
| return _mask == that._mask && _addr == that._addr; |
| } |
| |
| inline bool |
| IP4Net::operator!=(self_type const &that) const { |
| return _mask != that._mask || _addr != that._addr; |
| } |
| |
| inline IP4Net::self_type & |
| IP4Net::assign(IP4Addr const &addr, IPMask const &mask) { |
| _addr = addr & mask; |
| _mask = mask; |
| return *this; |
| } |
| |
| inline IP6Net::IP6Net(swoc::IP6Addr addr, swoc::IPMask mask) : _addr(addr & mask), _mask(mask) {} |
| |
| inline IPMask const & |
| IP6Net::mask() const { |
| return _mask; |
| } |
| |
| inline bool |
| IP6Net::is_valid() const { |
| return _mask.is_valid(); |
| } |
| |
| inline IP6Addr |
| IP6Net::lower_bound() const { |
| return _addr; |
| } |
| |
| inline IP6Addr |
| IP6Net::upper_bound() const { |
| return _addr | _mask; |
| } |
| |
| inline IP6Range |
| IP6Net::as_range() const { |
| return {this->lower_bound(), this->upper_bound()}; |
| } |
| |
| inline bool |
| IP6Net::operator==(self_type const &that) const { |
| return _mask == that._mask && _addr == that._addr; |
| } |
| |
| inline bool |
| IP6Net::operator!=(self_type const &that) const { |
| return _mask != that._mask || _addr != that._addr; |
| } |
| |
| inline IP6Net::self_type & |
| IP6Net::assign(IP6Addr const &addr, IPMask const &mask) { |
| _addr = addr & mask; |
| _mask = mask; |
| return *this; |
| } |
| |
| inline IPNet::IPNet(IPAddr const &addr, IPMask const &mask) : _addr(addr & mask), _mask(mask) {} |
| |
| inline IPNet::IPNet(TextView text) { |
| this->load(text); |
| } |
| |
| inline bool |
| IPNet::is_valid() const { |
| return _mask.is_valid(); |
| } |
| |
| inline IPAddr |
| IPNet::lower_bound() const { |
| return _addr; |
| } |
| |
| inline IPAddr |
| IPNet::upper_bound() const { |
| return _addr | _mask; |
| } |
| |
| inline IPMask::raw_type |
| IPNet::width() const { |
| return _mask.width(); |
| } |
| |
| inline IPMask const & |
| IPNet::mask() const { |
| return _mask; |
| } |
| |
| inline IPRange |
| IPNet::as_range() const { |
| return {this->lower_bound(), this->upper_bound()}; |
| } |
| |
| inline IPNet::self_type & |
| IPNet::assign(IPAddr const &addr, IPMask const &mask) { |
| _addr = addr & mask; |
| _mask = mask; |
| return *this; |
| } |
| |
| inline bool |
| IPNet::operator==(IPNet::self_type const &that) const { |
| return _mask == that._mask && _addr == that._addr; |
| } |
| |
| inline bool |
| IPNet::operator!=(IPNet::self_type const &that) const { |
| return _mask != that._mask || _addr != that._addr; |
| } |
| |
| inline bool |
| operator==(IPNet const &lhs, IP4Net const &rhs) { |
| return lhs.is_ip4() && lhs.ip4() == rhs; |
| } |
| |
| inline bool |
| operator==(IP4Net const &lhs, IPNet const &rhs) { |
| return rhs.is_ip4() && rhs.ip4() == lhs; |
| } |
| |
| inline bool |
| operator==(IPNet const &lhs, IP6Net const &rhs) { |
| return lhs.is_ip6() && lhs.ip6() == rhs; |
| } |
| |
| inline bool |
| operator==(IP6Net const &lhs, IPNet const &rhs) { |
| return rhs.is_ip6() && rhs.ip6() == lhs; |
| } |
| |
| // +++ Range -> Network classes +++ |
| |
| inline bool |
| IP4Range::NetSource::is_valid(swoc::IP4Addr mask) const { |
| return ((mask._addr & _range._min._addr) == _range._min._addr) && ((_range._min._addr | ~mask._addr) <= _range._max._addr); |
| } |
| |
| inline IP4Net |
| IP4Range::NetSource::operator*() const { |
| return IP4Net{_range.min(), IPMask{_cidr}}; |
| } |
| |
| inline IP4Range::NetSource::iterator |
| IP4Range::NetSource::begin() const { |
| return *this; |
| } |
| |
| inline IP4Range::NetSource::iterator |
| IP4Range::NetSource::end() { |
| return self_type{range_type{}}; |
| } |
| |
| inline bool |
| IP4Range::NetSource::empty() const { |
| return _range.empty(); |
| } |
| |
| inline IPMask |
| IP4Range::NetSource::mask() const { |
| return IPMask{_cidr}; |
| } |
| |
| inline auto |
| IP4Range::NetSource::operator->() -> self_type * { |
| return this; |
| } |
| |
| inline IP4Addr const & |
| IP4Range::NetSource::addr() const { |
| return _range.min(); |
| } |
| |
| inline bool |
| IP4Range::NetSource::operator==(IP4Range::NetSource::self_type const &that) const { |
| return ((_cidr == that._cidr) && (_range == that._range)) || (_range.empty() && that._range.empty()); |
| } |
| |
| inline bool |
| IP4Range::NetSource::operator!=(IP4Range::NetSource::self_type const &that) const { |
| return !(*this == that); |
| } |
| |
| inline auto |
| IP6Range::NetSource::begin() const -> iterator { |
| return *this; |
| } |
| |
| inline auto |
| IP6Range::NetSource::end() const -> iterator { |
| return self_type{range_type{}}; |
| } |
| |
| inline bool |
| IP6Range::NetSource::empty() const { |
| return _range.empty(); |
| } |
| |
| inline IP6Net |
| IP6Range::NetSource::operator*() const { |
| return IP6Net{_range.min(), _mask}; |
| } |
| |
| inline auto |
| IP6Range::NetSource::operator->() -> self_type * { |
| return this; |
| } |
| |
| inline bool |
| IP6Range::NetSource::is_valid(IPMask const &mask) { |
| return ((_range.min() & mask) == _range.min()) && ((_range.min() | mask) <= _range.max()); |
| } |
| |
| inline bool |
| IP6Range::NetSource::operator==(IP6Range::NetSource::self_type const &that) const { |
| return ((_mask == that._mask) && (_range == that._range)) || (_range.empty() && that._range.empty()); |
| } |
| |
| inline bool |
| IP6Range::NetSource::operator!=(IP6Range::NetSource::self_type const &that) const { |
| return !(*this == that); |
| } |
| |
| inline IP6Addr const & |
| IP6Range::NetSource::addr() const { |
| return _range.min(); |
| } |
| |
| inline IPMask |
| IP6Range::NetSource::mask() const { |
| return _mask; |
| } |
| |
| inline IPRange::NetSource::NetSource(IPRange::NetSource::range_type const &range) { |
| if (range.is_ip4()) { |
| new (&_ip4) decltype(_ip4)(range.ip4()); |
| _family = AF_INET; |
| } else if (range.is_ip6()) { |
| new (&_ip6) decltype(_ip6)(range.ip6()); |
| _family = AF_INET6; |
| } |
| } |
| |
| inline auto |
| IPRange::NetSource::begin() const -> iterator { |
| return *this; |
| } |
| |
| inline auto |
| IPRange::NetSource::end() const -> iterator { |
| return AF_INET == _family ? self_type{IP4Range{}} : AF_INET6 == _family ? self_type{IP6Range{}} : self_type{IPRange{}}; |
| } |
| |
| inline IPAddr |
| IPRange::NetSource::addr() const { |
| if (AF_INET == _family) { |
| return _ip4.addr(); |
| } else if (AF_INET6 == _family) { |
| return _ip6.addr(); |
| } |
| return {}; |
| } |
| |
| inline IPMask |
| IPRange::NetSource::mask() const { |
| if (AF_INET == _family) { |
| return _ip4.mask(); |
| } else if (AF_INET6 == _family) { |
| return _ip6.mask(); |
| } |
| return {}; |
| } |
| |
| inline IPNet |
| IPRange::NetSource::operator*() const { |
| return {this->addr(), this->mask()}; |
| } |
| |
| inline auto |
| IPRange::NetSource::operator++() -> self_type & { |
| if (AF_INET == _family) { |
| ++_ip4; |
| } else if (AF_INET6 == _family) { |
| ++_ip6; |
| } |
| return *this; |
| } |
| |
| inline auto |
| IPRange::NetSource::operator->() -> self_type * { |
| return this; |
| } |
| |
| inline bool |
| IPRange::NetSource::operator==(self_type const &that) const { |
| if (_family != that._family) { |
| return false; |
| } |
| if (AF_INET == _family) { |
| return _ip4 == that._ip4; |
| } else if (AF_INET6 == _family) { |
| return _ip6 == that._ip6; |
| } else if (AF_UNSPEC == _family) { |
| return true; |
| } |
| return false; |
| } |
| |
| inline bool |
| IPRange::NetSource::operator!=(self_type const &that) const { |
| return !(*this == that); |
| } |
| |
| // --- IPSpace |
| |
| template <typename PAYLOAD> |
| auto |
| IPSpace<PAYLOAD>::mark(IPRange const &range, PAYLOAD const &payload) -> self_type & { |
| if (range.is(AF_INET)) { |
| _ip4.mark(range.ip4(), payload); |
| } else if (range.is(AF_INET6)) { |
| _ip6.mark(range.ip6(), payload); |
| } |
| return *this; |
| } |
| |
| template <typename PAYLOAD> |
| auto |
| IPSpace<PAYLOAD>::fill(IPRange const &range, PAYLOAD const &payload) -> self_type & { |
| if (range.is(AF_INET6)) { |
| _ip6.fill(range.ip6(), payload); |
| } else if (range.is(AF_INET)) { |
| _ip4.fill(range.ip4(), payload); |
| } |
| return *this; |
| } |
| |
| template <typename PAYLOAD> |
| auto |
| IPSpace<PAYLOAD>::erase(IPRange const &range) -> self_type & { |
| if (range.is(AF_INET)) { |
| _ip4.erase(range.ip4()); |
| } else if (range.is(AF_INET6)) { |
| _ip6.erase(range.ip6()); |
| } |
| return *this; |
| } |
| |
| template <typename PAYLOAD> |
| template <typename F, typename U> |
| auto |
| IPSpace<PAYLOAD>::blend(IPRange const &range, U const &color, F &&blender) -> self_type & { |
| if (range.is(AF_INET)) { |
| _ip4.blend(range.ip4(), color, blender); |
| } else if (range.is(AF_INET6)) { |
| _ip6.blend(range.ip6(), color, blender); |
| } |
| return *this; |
| } |
| |
| template <typename PAYLOAD> |
| template <typename F, typename U> |
| auto |
| IPSpace<PAYLOAD>::blend(IP4Range const &range, U const &color, F &&blender) -> self_type & { |
| _ip4.blend(range, color, std::forward<F>(blender)); |
| return *this; |
| } |
| |
| template <typename PAYLOAD> |
| template <typename F, typename U> |
| auto |
| IPSpace<PAYLOAD>::blend(IP6Range const &range, U const &color, F &&blender) -> self_type & { |
| _ip6.blend(range, color, std::forward<F>(blender)); |
| return *this; |
| } |
| |
| template <typename PAYLOAD> |
| void |
| IPSpace<PAYLOAD>::clear() { |
| _ip4.clear(); |
| _ip6.clear(); |
| } |
| |
| template <typename PAYLOAD> |
| auto IPSpace<PAYLOAD>::begin() -> iterator { return iterator{_ip4.begin(), _ip6.begin()}; } |
| |
| template <typename PAYLOAD> |
| auto IPSpace<PAYLOAD>::begin() const -> const_iterator { return const_cast<self_type *>(this)->begin(); } |
| |
| template <typename PAYLOAD> |
| auto IPSpace<PAYLOAD>::end() -> iterator { return iterator{_ip4.end(), _ip6.end()}; } |
| |
| template <typename PAYLOAD> |
| auto IPSpace<PAYLOAD>::end() const -> const_iterator { return const_cast<self_type *>(this)->end(); } |
| |
| template <typename PAYLOAD> |
| auto IPSpace<PAYLOAD>::begin_ip4() -> iterator { return this->begin(); } |
| |
| template <typename PAYLOAD> |
| auto IPSpace<PAYLOAD>::begin_ip4() const -> const_iterator { return this->begin(); } |
| |
| template <typename PAYLOAD> |
| auto IPSpace<PAYLOAD>::end_ip4() -> iterator { return { _ip4.end(), _ip6.begin() }; } |
| |
| template <typename PAYLOAD> |
| auto IPSpace<PAYLOAD>::end_ip4() const -> const_iterator { return const_cast<self_type*>(this)->end_ip4(); } |
| |
| template <typename PAYLOAD> |
| auto IPSpace<PAYLOAD>::begin_ip6() -> iterator { |
| return { _ip4.end(), _ip6.begin() }; |
| } |
| |
| template <typename PAYLOAD> |
| auto IPSpace<PAYLOAD>::begin_ip6() const -> const_iterator { |
| return const_cast<self_type*>(this)->begin_ip6(); |
| } |
| |
| template <typename PAYLOAD> |
| auto IPSpace<PAYLOAD>::end_ip6() -> iterator { return this->end(); } |
| |
| template <typename PAYLOAD> |
| auto IPSpace<PAYLOAD>::end_ip6() const -> const_iterator { return this->end(); } |
| |
| template <typename PAYLOAD> |
| auto |
| IPSpace<PAYLOAD>::find(IPAddr const &addr) -> iterator { |
| if (addr.is_ip4()) { |
| return this->find(addr.ip4()); |
| } else if (addr.is_ip6()) { |
| return this->find(addr.ip6()); |
| } |
| return this->end(); |
| } |
| |
| template <typename PAYLOAD> |
| auto IPSpace<PAYLOAD>::find(IPAddr const &addr) const -> const_iterator { |
| return const_cast<self_type *>(this)->find(addr); |
| } |
| |
| template <typename PAYLOAD> |
| auto |
| IPSpace<PAYLOAD>::find(IP4Addr const &addr) -> iterator { |
| if ( auto spot = _ip4.find(addr) ; spot != _ip4.end()) { |
| return { spot, _ip6.begin() }; |
| } |
| return this->end(); |
| } |
| |
| template <typename PAYLOAD> |
| auto |
| IPSpace<PAYLOAD>::find(IP4Addr const &addr) const -> const_iterator { |
| return const_cast<self_type *>(this)->find(addr); |
| } |
| |
| template <typename PAYLOAD> |
| auto IPSpace<PAYLOAD>::find(IP6Addr const &addr) -> iterator { return {_ip4.end(), _ip6.find(addr)}; } |
| |
| template <typename PAYLOAD> |
| auto IPSpace<PAYLOAD>::find(IP6Addr const &addr) const -> const_iterator { return {_ip4.end(), _ip6.find(addr)}; } |
| |
| template <typename PAYLOAD> |
| auto |
| IPSpace<PAYLOAD>::begin(sa_family_t family) const -> const_iterator { |
| if (AF_INET == family) { |
| return this->begin_ip4(); |
| } else if (AF_INET6 == family) { |
| return this->begin_ip6(); |
| } |
| return this->end(); |
| } |
| |
| template <typename PAYLOAD> |
| auto |
| IPSpace<PAYLOAD>::end(sa_family_t family) const -> const_iterator { |
| if (AF_INET == family) { |
| return this->end_ip4(); |
| } else if (AF_INET6 == family) { |
| return this->end_ip6(); |
| } |
| return this->end(); |
| } |
| |
| template <typename PAYLOAD> |
| size_t |
| IPSpace<PAYLOAD>::count(sa_family_t f) const { |
| return IP4Addr::AF_value == f ? _ip4.count() : IP6Addr::AF_value == f ? _ip6.count() : 0; |
| } |
| |
| }} // namespace swoc::SWOC_VERSION_NS |
| |
| /// @cond NOT_DOCUMENTED |
| namespace std { |
| |
| // -- Tuple support for IP4Net -- |
| template <> class tuple_size<swoc::IP4Net> : public std::integral_constant<size_t, 2> {}; |
| |
| template <size_t IDX> class tuple_element<IDX, swoc::IP4Net> { static_assert("swoc::IP4Net tuple index out of range"); }; |
| |
| template <> class tuple_element<0, swoc::IP4Net> { |
| public: |
| using type = swoc::IP4Addr; |
| }; |
| |
| template <> class tuple_element<1, swoc::IP4Net> { |
| public: |
| using type = swoc::IPMask; |
| }; |
| |
| // -- Tuple support for IP6Net -- |
| template <> class tuple_size<swoc::IP6Net> : public std::integral_constant<size_t, 2> {}; |
| |
| template <size_t IDX> class tuple_element<IDX, swoc::IP6Net> { static_assert("swoc::IP6Net tuple index out of range"); }; |
| |
| template <> class tuple_element<0, swoc::IP6Net> { |
| public: |
| using type = swoc::IP6Addr; |
| }; |
| |
| template <> class tuple_element<1, swoc::IP6Net> { |
| public: |
| using type = swoc::IPMask; |
| }; |
| |
| // -- Tuple support for IPNet -- |
| template <> class tuple_size<swoc::IPNet> : public std::integral_constant<size_t, 2> {}; |
| |
| template <size_t IDX> class tuple_element<IDX, swoc::IPNet> { static_assert("swoc::IPNet tuple index out of range"); }; |
| |
| template <> class tuple_element<0, swoc::IPNet> { |
| public: |
| using type = swoc::IPAddr; |
| }; |
| |
| template <> class tuple_element<1, swoc::IPNet> { |
| public: |
| using type = swoc::IPMask; |
| }; |
| |
| } // namespace std |
| |
| namespace swoc { inline namespace SWOC_VERSION_NS { |
| |
| template <size_t IDX> |
| typename std::tuple_element<IDX, IP4Net>::type |
| get(swoc::IP4Net const &net) { |
| if constexpr (IDX == 0) { |
| return net.lower_bound(); |
| } else if constexpr (IDX == 1) { |
| return net.mask(); |
| } |
| } |
| |
| template <size_t IDX> |
| typename std::tuple_element<IDX, IP6Net>::type |
| get(swoc::IP6Net const &net) { |
| if constexpr (IDX == 0) { |
| return net.lower_bound(); |
| } else if constexpr (IDX == 1) { |
| return net.mask(); |
| } |
| } |
| |
| template <size_t IDX> |
| typename std::tuple_element<IDX, IPNet>::type |
| get(swoc::IPNet const &net) { |
| if constexpr (IDX == 0) { |
| return net.lower_bound(); |
| } else if constexpr (IDX == 1) { |
| return net.mask(); |
| } |
| } |
| /// @endcond |
| |
| }} // namespace swoc::SWOC_VERSION_NS |