code/include/swoc/IPEndpoint.h

// SPDX-License-Identifier: Apache-2.0
// Copyright Network Geographics 2014
/** @file
   IPEndpoint - wrapper for raw socket address objects.
 */

#pragma once

#include <stdexcept>

#include "swoc/swoc_version.h"
#include "swoc/MemSpan.h"
#include "swoc/TextView.h"
#include "swoc/string_view_util.h"
#include "swoc/swoc_ip_util.h"

namespace swoc { inline namespace SWOC_VERSION_NS {

class IPAddr;
class IP4Addr;
class IP6Addr;

class IPSrv;
class IP4Srv;
class IP6Srv;

/** A union to hold @c sockaddr compliant IP address structures.

    This class contains a number of static methods to perform operations on external @c sockaddr
    instances. These are all duplicates of methods that operate on the internal @c sockaddr and
    are provided primarily for backwards compatibility during the shift to using this class.

    We use the term "endpoint" because these contain more than just the raw address, all of the data
    for an IP endpoint is present.
 */
union IPEndpoint {
  using self_type   = IPEndpoint; ///< Self reference type.
  using string_view = std::string_view;

  struct sockaddr sa;      ///< Generic address.
  struct sockaddr_in sa4;  ///< IPv4
  struct sockaddr_in6 sa6; ///< IPv6

  /// Default construct invalid instance.
  IPEndpoint();
  IPEndpoint(self_type const &that); ///< Copy constructor.
  ~IPEndpoint() = default;

  /// Construct from the @a text representation of an address.
  explicit IPEndpoint(string_view const &text);

  /// Construct from an address.
  explicit IPEndpoint(IPAddr const &addr);

  /// Construct from address and port.
  explicit IPEndpoint(IPSrv const &srv);

  /// Construct from generic socket address.
  IPEndpoint(sockaddr const *addr);

  /// Construct from @a sockaddr_in
  IPEndpoint(sockaddr_in const *sin);

  /// Construct from @a sockaddr_in6
  IPEndpoint(sockaddr_in6 const *sin6);

  /// Copy assignment.
  self_type &operator=(self_type const &that);

  /** Break a string in to IP address relevant tokens.
   *
   * @param src Source text. [in]
   * @param host The host / address. [out]
   * @param port The host_order_port. [out]
   * @param rest Any text past the end of the IP address. [out]
   * @return @c true if an IP address was found, @c false otherwise.
   *
   * Any of the out parameters can be @c nullptr in which case they are not updated.
   * This parses and discards the IPv6 brackets.
   *
   * @note This is intended for internal use to do address parsing, but it can be useful in other contexts.
   */
  static bool tokenize(string_view src, string_view *host = nullptr, string_view *port = nullptr, string_view *rest = nullptr);

  /** Parse a string for an IP address.

      The address resulting from the parse is copied to this object if the conversion is successful,
      otherwise this object is invalidated.

      @return @c true on success, @c false otherwise.
  */
  bool parse(string_view const &str);

  /// Invalidate a @c sockaddr.
  static void invalidate(sockaddr *addr);

  /// Invalidate this endpoint.
  self_type &invalidate();

  /** Copy (assign) the contents of @a src to @a dst.
   *
   * The caller must ensure @a dst is large enough to hold the contents of @a src, the size of which
   * can vary depending on the type of address in @a dst.
   *
   * @param dst Destination.
   * @param src Source.
   * @return @c true if @a dst is a valid IP address, @c false otherwise.
   */
  static bool assign(sockaddr *dst, sockaddr const *src);

  /** Assign from a socket address.
      The entire address (all parts) are copied if the @a ip is valid.
  */
  self_type &assign(sockaddr const *addr);

  /** Assign from IPv4 socket address.
   *
   * @param sin IPv4 socket address.
   * @return @a this
   */
  self_type &assign(sockaddr_in const *sin);

  /** Assign from IPv6 socket address.
   *
   * @param sin6 IPv6 socket address.
   * @return @a this
   */
  self_type &assign(sockaddr_in6 const *sin6);

  /// Assign from IP address.
  self_type &assign(IPAddr const &addr);

  [[deprecated("Use IPSrv")]] self_type &assign(IPAddr const &addr, in_port_t port);

  /// Assign from IPv4 address.
  self_type &assign(IP4Addr const &addr);

  /// Assign from IPv4 address.
  self_type &assign(IP6Addr const &addr);

  /// Assign from IPv4 service.
  self_type &assign(IP4Srv const &srv);

  /// Assign from IPv6 service.
  self_type &assign(IP6Srv const &srv);

  /// Assign from IP service.
  self_type &assign(IPSrv const &srv);

  /// Copy to @a sa.
  const self_type &copy_to(sockaddr *addr) const;

  /// Test for valid IP address.
  bool is_valid() const;

  /// Test for IPv4.
  bool is_ip4() const;

  /// Test for IPv6.
  bool is_ip6() const;

  /** Effectively size of the address.
   *
   * @return The size of the structure appropriate for the address family of the stored address.
   */
  socklen_t size() const;

  /// @return The IP address family.
  sa_family_t family() const;

  /// @return A pointer to a @c sockaddr_in or @c nullptr if not IPv4.
  sockaddr_in *ip4();

  /// @return A pointer to a @c sockaddr_in or @c nullptr if not IPv4.
  sockaddr_in const *ip4() const;

  /// @return A pointer to a @c sockaddr_in6 or @c nullptr if not IPv6.
  sockaddr_in6 *ip6();

  /// @return A pointer to a @c sockaddr_in6 or @c nullptr if not IPv6.
  sockaddr_in6 const *ip6() const;

  /// Set to be the ANY address for family @a family.
  /// @a family must be @c AF_INET or @c AF_INET6.
  /// @return This object.
  self_type &set_to_any(int family);

  /// @return @c true if this is the ANY address, @c false if not.
  bool is_any() const;

  /// Set to be loopback address for family @a family.
  /// @a family must be @c AF_INET or @c AF_INET6.
  /// @return This object.
  self_type &set_to_loopback(int family);

  /// @return @c true if this is a loopback address, @c false if not.
  bool is_loopback() const;

  /// @return @c true if the address is in the link local network.
  bool is_link_local() const;

  /// @return @c true if the address is in the link local network.
  static bool is_link_local(sockaddr const * sa);

  /// @return @c true if the address is private.
  bool is_private() const;

  /// @return @c true if the address is private.
  static bool is_private(sockaddr const * sa);

  /// @return @c true if the address is multicast.
  bool is_multicast() const;

  /// @return @c true if the address is multicast.
  static bool is_multicast(sockaddr const * sa);

  /** Port in network order.
   *
   * @return The port or 0 if not a valid IP address.
   */
  in_port_t network_order_port() const;

  /** Port in host order.
   *
   * @return The port or 0 if not a valid IP address.
   */
  in_port_t host_order_port() const;

  /// Test for valid IP address.
  /// @param sa The socket address.
  /// @return @c true if @a sa contains a valid IP address, @c false if not.
  /// @a sa can be @c nullptr in which case @c false is returned.
  static bool is_valid(sockaddr const *sa);

  /// Direct access to port.
  /// @return Reference to the port in the socket address.
  /// @note If @a sa is not a valid IP address an assertion is thrown.
  /// @note The raw port is in network order.
  /// @a is_valid
  static in_port_t &port(sockaddr *sa);

  /** Port in network order.
   *
   * @param sa The socket address.
   * @return The port or 0 if @a sa is not a valid IP address.
   */
  static in_port_t network_order_port(sockaddr const *sa);

  /** Port in host order.
   *
   * @param sa The socket address.
   * @return The port or 0 if @a sa is not a valid IP address.
   */
  static in_port_t host_order_port(sockaddr const *sa);

  /// Automatic conversion to @c sockaddr.
  operator sockaddr *();

  /// Automatic conversion to @c sockaddr.
  operator sockaddr const *() const;

  /// Size of the sockaddr variant based on the family.
  size_t sa_size() const;

  /// Size of the sockaddr based on the family.
  static size_t sa_size(sockaddr const* sa);

  /** The address as a byte sequence.
   *
   * @return Span of the address memory.
   *
   * This is raw access. If the contained data is not a valid address family an empty span is returned.
   */
  swoc::MemSpan<void const> raw_addr() const;

  /// The string name of the address family.
  static string_view family_name(sa_family_t family);
};

inline IPEndpoint::IPEndpoint() {
  sa.sa_family = AF_UNSPEC;
}

inline IPEndpoint::IPEndpoint(IPAddr const &addr) {
  this->assign(addr);
}

inline IPEndpoint::IPEndpoint(IPSrv const &srv) {
  this->assign(srv);
}

inline IPEndpoint::IPEndpoint(sockaddr const *addr) {
  this->assign(addr);
}

inline IPEndpoint::IPEndpoint(IPEndpoint::self_type const &that) : self_type(&that.sa) {}

inline IPEndpoint &
IPEndpoint::invalidate() {
  sa.sa_family = AF_UNSPEC;
  return *this;
}

inline void
IPEndpoint::invalidate(sockaddr *addr) {
  addr->sa_family = AF_UNSPEC;
}

inline bool
IPEndpoint::is_valid() const {
  return sa.sa_family == AF_INET || sa.sa_family == AF_INET6;
}

inline IPEndpoint &
IPEndpoint::operator=(self_type const &that) {
  self_type::assign(&sa, &that.sa);
  return *this;
}

inline IPEndpoint &
IPEndpoint::assign(sockaddr_in const *sin) {
  std::memcpy(&sa4, sin, sizeof(sockaddr_in));
  return *this;
}

inline IPEndpoint &
IPEndpoint::assign(sockaddr_in6 const *sin6) {
  std::memcpy(&sa6, sin6, sizeof(sockaddr_in6));
  return *this;
}

inline IPEndpoint &
IPEndpoint::assign(sockaddr const *src) {
  self_type::assign(&sa, src);
  return *this;
}

inline IPEndpoint const &
IPEndpoint::copy_to(sockaddr *addr) const {
  self_type::assign(addr, &sa);
  return *this;
}

inline bool
IPEndpoint::is_ip4() const {
  return AF_INET == sa.sa_family;
}

inline bool
IPEndpoint::is_ip6() const {
  return AF_INET6 == sa.sa_family;
}

inline sa_family_t
IPEndpoint::family() const {
  return sa.sa_family;
}

inline sockaddr_in *
IPEndpoint::ip4() {
  return this->is_ip4() ? &sa4 : nullptr;
}

inline sockaddr_in const *
IPEndpoint::ip4() const {
  return this->is_ip4() ? &sa4 : nullptr;
}

inline sockaddr_in6 *
IPEndpoint::ip6() {
  return this->is_ip6() ? &sa6 : nullptr;
}

inline sockaddr_in6 const *
IPEndpoint::ip6() const {
  return this->is_ip6() ? &sa6 : nullptr;
}

inline in_port_t
IPEndpoint::network_order_port() const {
  return this->is_valid() ? this->port(const_cast<sockaddr *>(&sa)) : 0;
}

inline in_port_t
IPEndpoint::host_order_port() const {
  return ntohs(this->network_order_port());
}

inline bool
IPEndpoint::is_valid(sockaddr const *sa) {
  return sa && (sa->sa_family == AF_INET || sa->sa_family == AF_INET6);
}

inline in_port_t &
IPEndpoint::port(sockaddr *sa) {
  switch (sa->sa_family) {
  case AF_INET:
    return reinterpret_cast<sockaddr_in *>(sa)->sin_port;
  case AF_INET6:
    return reinterpret_cast<sockaddr_in6 *>(sa)->sin6_port;
  }
  // Force a failure upstream by returning a null reference.
  throw std::domain_error("sockaddr does not contain a valid IP address");
}

inline in_port_t
IPEndpoint::network_order_port(sockaddr const *sa) {
  return self_type::is_valid(sa) ? self_type::port(const_cast<sockaddr *>(sa)) : 0;
}

inline in_port_t
IPEndpoint::host_order_port(sockaddr const *sa) {
  return self_type::is_valid(sa) ? ntohs(self_type::port(const_cast<sockaddr *>(sa))) : 0;
}

inline swoc::MemSpan<void const>
IPEndpoint::raw_addr() const {
  switch (sa.sa_family) {
  case AF_INET:
    return {&sa4.sin_addr, sizeof(sa4.sin_addr)};
  case AF_INET6:
    return {&sa6.sin6_addr, sizeof(sa6.sin6_addr)};
  }
  return {};
}

inline bool IPEndpoint::is_link_local() const {
  return swoc::ip::is_link_local(&sa);
}

inline bool IPEndpoint::is_link_local(sockaddr const * sa) {
  return swoc::ip::is_link_local(sa);
}

inline bool IPEndpoint::is_private() const {
  return swoc::ip::is_private(&sa);
}

inline bool IPEndpoint::is_private(sockaddr const * sa) {
  return swoc::ip::is_private(sa);
}

inline bool IPEndpoint::is_multicast() const {
  return swoc::ip::is_multicast(&sa);
}

inline bool IPEndpoint::is_multicast(sockaddr const * sa) {
  return swoc::ip::is_multicast(sa);
}

inline IPEndpoint::operator sockaddr *() { return &sa; }

inline IPEndpoint::operator sockaddr const *() const { return &sa; }

inline size_t IPEndpoint::sa_size() const {
  return sa_size(&sa);
}

inline size_t IPEndpoint::sa_size(sockaddr const* sa) {
  return AF_INET == sa->sa_family ? sizeof(sockaddr_in) : AF_INET6 == sa->sa_family ? sizeof(sockaddr_in6) : sizeof(sockaddr);
}

}} // namespace swoc::SWOC_VERSION_NS