DwmIpv6PrefixMap.hh

Go to the documentation of this file.

//===========================================================================
// @(#) $DwmPath$
//===========================================================================
//  Copyright (c) Daniel W. McRobb 2021, 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 _DWMIPV6PREFIXMAP_HH_
#define _DWMIPV6PREFIXMAP_HH_
 
#include <map>
#include <mutex>
#include <shared_mutex>
#include <unordered_map>
#include <vector>
 
#include "DwmASIO.hh"
#include "DwmBZ2IO.hh"
#include "DwmDescriptorIO.hh"
#include "DwmFileIO.hh"
#include "DwmGZIO.hh"
#include "DwmIOUtils.hh"
#include "DwmIpv6Prefix.hh"
#include "DwmStreamIO.hh"
 
namespace Dwm {
 
  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  struct OurIpv6PrefixHash
  {
    inline size_t operator () (const Dwm::Ipv6Prefix & pfx) const
    {
      return pfx.Hash();
    }
  };
 
  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  template <typename T, typename Hash = OurIpv6PrefixHash>
  class Ipv6PrefixMap
  {
  public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    using MapType = std::unordered_map<Ipv6Prefix,T,Hash>;
    using LengthMapType = std::map<uint8_t,uint64_t>;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    using MapPair = std::pair<MapType,LengthMapType>;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv6PrefixMap()
        : _mtx(), _maps()
    {
      _maps.first.max_load_factor(.25);
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    void Add(const Ipv6Prefix & pfx, const T & value)
    {
      std::unique_lock  lck(_mtx);
      return Add(lck, pfx, value);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    void Add(std::unique_lock<std::shared_mutex> & lck,
             const Ipv6Prefix & pfx, const T & value)
    {
      assert((lck.mutex() == &_mtx) && lck.owns_lock());
      if (_maps.first.insert_or_assign(pfx, value).second) {
        _maps.second[pfx.MaskLength()]++;
      }
      return;
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Find(const Ipv6Prefix & pfx, T & value) const
    {
      std::shared_lock  lck(_mtx);
      return Find(lck, pfx, value);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Find(std::shared_lock<std::shared_mutex> & lck,
              const Ipv6Prefix & pfx, T & value) const
    {
      assert((lck.mutex() == &_mtx) && lck.owns_lock());
      return FindNoLock(pfx, value);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Find(std::unique_lock<std::shared_mutex> & lck,
              const Ipv6Prefix & pfx, T & value) const
    {
      assert((lck.mutex() == &_mtx) && lck.owns_lock());
      return FindNoLock(pfx, value);
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool FindLongest(const Ipv6Address & addr,
                     std::pair<Ipv6Prefix,T> & value) const
    {
      std::shared_lock  lck(_mtx);
      return FindLongest(lck, addr, value);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool FindLongest(std::shared_lock<std::shared_mutex> & lck,
                     const Ipv6Address & addr,
                     std::pair<Ipv6Prefix,T> & value) const
    {
      assert((lck.mutex() == &_mtx) && lck.owns_lock());
      return FindLongestNoLock(addr, value);
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool FindLongest(std::unique_lock<std::shared_mutex> & lck,
                     const Ipv6Address & addr,
                     std::pair<Ipv6Prefix,T> & value) const
    {
      assert((lck.mutex() == &_mtx) && lck.owns_lock());
      return FindLongestNoLock(addr, value);
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool FindMatches(const Ipv6Address & addr,
                     std::vector<std::pair<Ipv6Prefix,T>> & values) const
    {
      std::shared_lock  lck(_mtx);
      return FindMatches(lck, addr, values);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool FindMatches(std::shared_lock<std::shared_mutex> & lck,
                     const Ipv6Address & addr,
                     std::vector<std::pair<Ipv6Prefix,T>> & values) const
    {
      assert((lck.mutex() == &_mtx) && lck.owns_lock());
      return FindMatchesNoLock(addr, values);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool FindMatches(std::unique_lock<std::shared_mutex> & lck,
                     const Ipv6Address & addr,
                     std::vector<std::pair<Ipv6Prefix,T>> & values) const
    {
      assert((lck.mutex() == &_mtx) && lck.owns_lock());
      return FindMatchesNoLock(addr, values);
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Remove(const Ipv6Prefix & pfx)
    {
      std::unique_lock  lck(_mtx);
      return Remove(lck, pfx);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Remove(std::unique_lock<std::shared_mutex> & lck,
                const Ipv6Prefix & pfx)
    {
      assert((lck.mutex() == &_mtx) && lck.owns_lock());
      bool  rc = false;
      auto  it = _maps.first.find(pfx);
      if (it != _maps.first.end()) {
        _maps.first.erase(it);
        auto lit = _maps.second.find(pfx.MaskLength());
        lit->second--;
        if (0 == lit->second) {
          _maps.second.erase(lit);
        }
        rc = true;
      }
      return rc;
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    void Clear()
    {
      std::unique_lock  lck(_mtx);
      return Clear(lck);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    void Clear(std::unique_lock<std::shared_mutex> & lck)
    {
      assert((lck.mutex() == &_mtx) && lck.owns_lock());
      _maps.first.clear();
      _maps.second.clear();
      return;
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Empty() const
    {
      std::shared_lock  lck(_mtx);
      return Empty(lck);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Empty(std::shared_lock<std::shared_mutex> & lck) const
    {
      assert((lck.mutex() == &_mtx) && lck.owns_lock());
      return _maps.first.empty();
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Empty(std::unique_lock<std::shared_mutex> & lck) const
    {
      assert((lck.mutex() == &_mtx) && lck.owns_lock());
      return _maps.first.empty();
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::istream & Read(std::istream & is)
    {
      std::unique_lock  lck(_mtx);
      return StreamIO::Read(is, _maps);
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::ostream & Write(std::ostream & os) const
    {
      std::shared_lock  lck(_mtx);
      return StreamIO::Write(os, _maps);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    size_t Read(FILE *f)
    {
      std::unique_lock  lck(_mtx);
      return FileIO::Read(f, _maps);
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    size_t Write(FILE *f) const
    {
      std::shared_lock  lck(_mtx);
      return FileIO::Write(f, _maps);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    ssize_t Read(int fd)
    {
      std::unique_lock  lck(_mtx);
      return DescriptorIO::Read(fd, _maps);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    ssize_t Write(int fd) const
    {
      std::shared_lock  lck(_mtx);
      return DescriptorIO::Write(fd, _maps);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int Read(gzFile gzf)
    {
      std::unique_lock  lck(_mtx);
      return GZIO::Read(gzf, _maps);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int Write(gzFile gzf) const
    {
      std::shared_lock  lck(_mtx);
      return GZIO::Write(gzf, _maps);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int BZRead(BZFILE *bzf)
    {
      std::unique_lock  lck(_mtx);
      return BZ2IO::BZRead(bzf, _maps);
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int BZWrite(BZFILE *bzf) const
    {
      std::shared_lock  lck(_mtx);
      return BZ2IO::BZWrite(bzf, _maps);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint64_t StreamedLength() const
    {
      std::shared_lock  lck(_mtx);
      return IOUtils::StreamedLength(_maps);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Read(boost::asio::ip::tcp::socket & s,
              boost::system::error_code & ec)
    {
      std::unique_lock  lck(_mtx);
      return ASIO::Read(s, _maps, ec);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Read(boost::asio::local::stream_protocol::socket & s,
              boost::system::error_code & ec)
    {
      std::unique_lock  lck(_mtx);
      return ASIO::Read(s, _maps, ec);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Read(boost::asio::generic::stream_protocol::socket & s,
              boost::system::error_code & ec)
    {
      std::unique_lock  lck(_mtx);
      return ASIO::Read(s, _maps, ec);
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Write(boost::asio::ip::tcp::socket & s,
               boost::system::error_code & ec) const
    {
      std::shared_lock  lck(_mtx);
      return ASIO::Write(s, _maps, ec);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Write(boost::asio::local::stream_protocol::socket & s,
               boost::system::error_code & ec) const
    {
      std::shared_lock  lck(_mtx);
      return ASIO::Write(s, _maps, ec);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Write(boost::asio::generic::stream_protocol::socket & s,
               boost::system::error_code & ec) const
    {
      std::shared_lock  lck(_mtx);
      return ASIO::Write(s, _maps, ec);
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::shared_lock<std::shared_mutex> SharedLock() const
    {
      return std::shared_lock(_mtx);
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::unique_lock<std::shared_mutex> UniqueLock()
    {
      return std::unique_lock(_mtx);
    }
    
  private:
    mutable std::shared_mutex  _mtx;
    MapPair                    _maps;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool FindNoLock(const Ipv6Prefix & pfx, T & value) const
    {
      bool  rc = false;
      auto  it = _maps.first.find(pfx);
      if (it != _maps.first.end()) {
        value = it->second;
        rc = true;
      }
      return rc;
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool FindLongestNoLock(const Ipv6Address & addr,
                           std::pair<Ipv6Prefix,T> & value) const
    {
      bool              rc = false;
      value.first.Set(addr, 128);
      for (auto lit = _maps.second.rbegin();
           lit != _maps.second.rend(); ++lit) {
        value.first.MaskLength(lit->first);
        auto  it = _maps.first.find(value.first);
        if (it != _maps.first.end()) {
          value.second = it->second;
          rc = true;
          break;
        }
      }
      return rc;
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool FindMatchesNoLock(const Ipv6Address & addr,
                           std::vector<std::pair<Ipv6Prefix,T>> & values) const
    {
      values.clear();
      std::pair<Ipv6Prefix,T>  value;
      for (auto lit = _maps.second.rbegin();
           lit != _maps.second.rend(); ++lit) {
        Ipv6Prefix  pfx(addr, lit->first);
        auto  it = _maps.first.find(pfx);
        if (it != _maps.first.end()) {
          value.first = pfx;
          value.second = it->second;
          values.push_back(value);
        }
      }
      return (! values.empty());
    }
 
  };
  
}  // namespace Dwm
 
#endif  // _DWMIPV6PREFIXMAP_HH_