DwmIpv4Prefix.hh

Go to the documentation of this file.

//===========================================================================
// @(#) $DwmPath$
//===========================================================================
//  Copyright (c) Daniel W. McRobb 2004-2006, 2023, 2024
//  All rights reserved.
//
//  Redistribution and use in source and binary forms, with or without
//  modification, are permitted provided that the following conditions
//  are met:
//
//  1. Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
//  2. Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in the
//     documentation and/or other materials provided with the distribution.
//  3. The names of the authors and copyright holders may not be used to
//     endorse or promote products derived from this software without
//     specific prior written permission.
//
//  IN NO EVENT SHALL DANIEL W. MCROBB BE LIABLE TO ANY PARTY FOR
//  DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
//  INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE,
//  EVEN IF DANIEL W. MCROBB HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
//  DAMAGE.
//
//  THE SOFTWARE PROVIDED HEREIN IS ON AN "AS IS" BASIS, AND
//  DANIEL W. MCROBB HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
//  UPDATES, ENHANCEMENTS, OR MODIFICATIONS. DANIEL W. MCROBB MAKES NO
//  REPRESENTATIONS AND EXTENDS NO WARRANTIES OF ANY KIND, EITHER 
//  IMPLIED OR EXPRESS, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
//  WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR
//  PURPOSE, OR THAT THE USE OF THIS SOFTWARE WILL NOT INFRINGE ANY 
//  PATENT, TRADEMARK OR OTHER RIGHTS.
//===========================================================================
 
//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
 
#ifndef _DWMIPV4PREFIX_HH_
#define _DWMIPV4PREFIX_HH_
 
#include <cstring>
#include <iostream>
#include <utility>
#include <vector>
#include <boost/asio.hpp>
 
#include "DwmIpv4Address.hh"
#include "DwmASIO.hh"
 
namespace Dwm {
 
  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  class Ipv4Prefix
  {
  public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv4Prefix();
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv4Prefix(const Ipv4Address & network, uint8_t maskLength);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv4Prefix(const Ipv4Address & network, const Ipv4Address & netmask);
    
    //------------------------------------------------------------------------
    //   For example, 128.35.104.1/16 will result in 128.35/16.
    //------------------------------------------------------------------------
    Ipv4Prefix(const std::string & prefix);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv4Prefix(const Ipv4Address & addr);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    inline Ipv4Prefix(const Ipv4Prefix & prefix)
    {
      memcpy(_data,prefix._data,5);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    inline Ipv4Prefix & operator = (const Ipv4Prefix & prefix)
    {
      if (&prefix != this) {
        memcpy(_data,prefix._data,5);
      }
      return(*this);
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual ~Ipv4Prefix();
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    inline Ipv4Address Network() const
    {
      return(*(ipv4addr_t *)this->_data);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    inline ipv4addr_t NetworkRaw() const
    {
      return(((ipv4addr_t *)this->_data)[0]);
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv4Address Netmask() const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    inline uint8_t MaskLength() const
    { return this->_data[4]; }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    inline uint8_t MaskLength(uint8_t maskLength)
    {
      if (maskLength < _data[4]) {
        if (maskLength == 0) {
          *(uint32_t *)_data = 0;
        }
        else {
          //  need to zero some bits
          uint32_t  mask = htonl(0xffffffff << (32 - maskLength));
          *(uint32_t *)_data &= mask;
        }
        _data[4] = maskLength;
      }
      else if (maskLength < 33) {
        _data[4] = maskLength;
      }
      return(_data[4]);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv4Address FirstAddress() const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv4Address LastAddress() const;
      
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Set(const Ipv4Address & network, uint8_t maskLength);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    void Set(const Ipv4Address & network, const Ipv4Address & netmask);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool operator < (const Ipv4Prefix & prefix) const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool operator > (const Ipv4Prefix & prefix) const;;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool operator == (const Ipv4Prefix & prefix) const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool operator != (const Ipv4Prefix & prefix) const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv4Prefix & operator ++ ();
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv4Prefix operator ++ (int);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv4Prefix & operator -- ();
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv4Prefix operator -- (int);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Contains(const Ipv4Address & address) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Contains(const Ipv4Prefix & prefix) const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Adjacent(const Ipv4Prefix & prefix) const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::pair<bool,Ipv4Prefix> Combine(const Ipv4Prefix & prefix) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    ssize_t Read(int fd);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    ssize_t Write(int fd) const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    size_t Read(FILE *f);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    size_t Write(FILE *f) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::istream & Read(std::istream & is);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::ostream & Write(std::ostream & os) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int Read(gzFile gzf);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int Write(gzFile gzf) const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int BZRead(BZFILE *bzf);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int BZWrite(BZFILE *bzf) const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Read(boost::asio::ip::tcp::socket & s,
              boost::system::error_code & ec);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Write(boost::asio::ip::tcp::socket & s,
               boost::system::error_code & ec) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Read(boost::asio::local::stream_protocol::socket & s,
              boost::system::error_code & ec);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Write(boost::asio::local::stream_protocol::socket & s,
               boost::system::error_code & ec) const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Read(boost::asio::generic::stream_protocol::socket & s,
              boost::system::error_code & ec);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Write(boost::asio::generic::stream_protocol::socket & s,
               boost::system::error_code & ec) const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    friend std::ostream & operator << (std::ostream & os, 
                                       const Ipv4Prefix & prefix);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::string ToString() const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::string ToShortString() const;
      
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    inline uint64_t StreamedLength() const
    { return(5); }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    inline const uint8_t *Data() const
    { return(_data); }
 
  private:
    alignas(4) uint8_t  _data[5];
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename S>
    requires IsSupportedASIOSocket<S>
    bool ASIO_Read(S & s, boost::system::error_code & ec)
    {
      using boost::asio::read, boost::asio::buffer;
      return ((read(s, buffer(_data, sizeof(_data)), ec) == sizeof(_data))
              && (! ec));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename S>
    requires IsSupportedASIOSocket<S>
    bool ASIO_Write(S & s, boost::system::error_code & ec) const
    {
      using boost::asio::write, boost::asio::buffer;
      return ((write(s, buffer(_data, sizeof(_data)), ec) == sizeof(_data))
              && (! ec));
    }
  };
 
  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  std::vector<Ipv4Prefix> Ipv4RangePrefixes(const Ipv4Address & addr1,
                                            const Ipv4Address & addr2);
  
}  // namespace Dwm
 
#endif  // _DWMIPV4PREFIX_HH_
 
//---------------------------- emacs settings -----------------------------
//  Local Variables:
//  mode: C++
//  tab-width: 2
//  indent-tabs-mode: nil
//  c-basic-offset: 2
//  End:
//-------------------------------------------------------------------------