nix-vector-routing.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2009 The Georgia Institute of Technology
 * Copyright (c) 2021 NITK Surathkal
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 * 
 * This file is adapted from the old ipv4-nix-vector-routing.h.
 *
 * Authors: Josh Pelkey <jpelkey@gatech.edu>
 * 
 * Modified by: Ameya Deshpande <ameyanrd@outlook.com>
 */
 
#ifndef NIX_VECTOR_ROUTING_H
#define NIX_VECTOR_ROUTING_H
 
#include "ns3/channel.h"
#include "ns3/node-container.h"
#include "ns3/node-list.h"
#include "ns3/net-device-container.h"
#include "ns3/ipv4-routing-protocol.h"
#include "ns3/ipv4-route.h"
#include "ns3/ipv6-route.h"
#include "ns3/ipv6-routing-protocol.h"
#include "ns3/nix-vector.h"
#include "ns3/bridge-net-device.h"
#include "ns3/nstime.h"
#include "ns3/ipv4-interface.h"
#include "ns3/ipv6-interface.h"
#include "ns3/ipv4-l3-protocol.h"
#include "ns3/ipv6-l3-protocol.h"
 
#include <map>
#include <unordered_map>
 
namespace ns3 {
 
template <typename T>
class NixVectorRouting : public std::enable_if<std::is_same<Ipv4RoutingProtocol, T>::value || std::is_same<Ipv6RoutingProtocol, T>::value, T>::type
{
  using IsIpv4 = std::is_same <Ipv4RoutingProtocol, T>;
 
  using Ip = typename std::conditional <IsIpv4::value, Ipv4, Ipv6>::type;
 
  using IpAddress = typename std::conditional<IsIpv4::value, Ipv4Address, Ipv6Address>::type;
 
  using IpRoute = typename std::conditional<IsIpv4::value, Ipv4Route, Ipv6Route>::type;
 
  using IpAddressHash = typename std::conditional<IsIpv4::value, Ipv4AddressHash, Ipv6AddressHash>::type;
 
  using IpHeader = typename std::conditional<IsIpv4::value, Ipv4Header, Ipv6Header>::type;
 
  using IpInterfaceAddress = typename std::conditional<IsIpv4::value, Ipv4InterfaceAddress, Ipv6InterfaceAddress>::type;
 
  using IpInterface = typename std::conditional<IsIpv4::value, Ipv4Interface, Ipv6Interface>::type;
 
  using IpL3Protocol = typename std::conditional<IsIpv4::value, Ipv4L3Protocol, Ipv6L3Protocol>::type;
 
public:
  NixVectorRouting ();
  ~NixVectorRouting ();
  static TypeId GetTypeId (void);
  void SetNode (Ptr<Node> node);
 
  void FlushGlobalNixRoutingCache (void) const;
 
  void PrintRoutingPath (Ptr<Node> source, IpAddress dest, Ptr<OutputStreamWrapper> stream, Time::Unit unit) const;
 
 
private:
 
  void FlushNixCache (void) const;
 
  void FlushIpRouteCache (void) const;
 
  void ResetTotalNeighbors (void);
 
  Ptr<NixVector> GetNixVector (Ptr<Node> source, IpAddress dest, Ptr<NetDevice> oif) const;
 
  Ptr<NixVector> GetNixVectorInCache (const IpAddress &address,  bool &foundInCache) const;
 
  Ptr<IpRoute> GetIpRouteInCache (IpAddress address);
 
  void GetAdjacentNetDevices (Ptr<NetDevice> netDevice, Ptr<Channel> channel, NetDeviceContainer & netDeviceContainer) const;
 
  Ptr<Node> GetNodeByIp (IpAddress dest) const;
 
  Ptr<IpInterface> GetInterfaceByNetDevice (Ptr<NetDevice> netDevice) const;
 
  bool BuildNixVector (const std::vector< Ptr<Node> > & parentVector, uint32_t source, uint32_t dest, Ptr<NixVector> nixVector) const;
 
  bool BuildNixVectorLocal (Ptr<NixVector> nixVector);
 
  uint32_t FindTotalNeighbors (Ptr<Node> node) const;
 
 
  Ptr<BridgeNetDevice> NetDeviceIsBridged (Ptr<NetDevice> nd) const;
 
 
  uint32_t FindNetDeviceForNixIndex (Ptr<Node> node, uint32_t nodeIndex, IpAddress & gatewayIp) const;
 
  bool BFS (uint32_t numberOfNodes,
            Ptr<Node> source,
            Ptr<Node> dest,
            std::vector< Ptr<Node> > & parentVector,
            Ptr<NetDevice> oif) const;
 
  void DoInitialize ();
 
  void DoDispose (void);
 
  typedef std::map<IpAddress, Ptr<NixVector> > NixMap_t;
  typedef std::map<IpAddress, Ptr<IpRoute> > IpRouteMap_t;
 
  typedef Callback<void, Ptr<IpRoute>, Ptr<const Packet>, const IpHeader &> UnicastForwardCallbackv4;
 
  typedef Callback<void, Ptr<const NetDevice>, Ptr<IpRoute>, Ptr<const Packet>, const IpHeader &> UnicastForwardCallbackv6;
 
  typedef typename std::conditional<IsIpv4::value, UnicastForwardCallbackv4, UnicastForwardCallbackv6>::type UnicastForwardCallback;
 
  typedef Callback<void, Ptr<Ipv4MulticastRoute>, Ptr<const Packet>, const IpHeader &> MulticastForwardCallbackv4;
 
  typedef Callback<void, Ptr<const NetDevice>, Ptr<Ipv6MulticastRoute>, Ptr<const Packet>, const IpHeader &> MulticastForwardCallbackv6;
 
  typedef typename std::conditional<IsIpv4::value, MulticastForwardCallbackv4, MulticastForwardCallbackv6>::type MulticastForwardCallback;
 
  typedef Callback<void, Ptr<const Packet>, const IpHeader &, uint32_t > LocalDeliverCallback;
 
  typedef Callback<void, Ptr<const Packet>, const IpHeader &, Socket::SocketErrno > ErrorCallback;
 
  /* From Ipv4RoutingProtocol and Ipv6RoutingProtocol */
  virtual Ptr<IpRoute> RouteOutput (Ptr<Packet> p, const IpHeader &header, Ptr<NetDevice> oif, Socket::SocketErrno &sockerr);
 
  virtual bool RouteInput (Ptr<const Packet> p, const IpHeader &header, Ptr<const NetDevice> idev,
                           UnicastForwardCallback ucb, MulticastForwardCallback mcb,
                           LocalDeliverCallback lcb, ErrorCallback ecb);
  
  virtual void NotifyInterfaceUp (uint32_t interface);
 
  virtual void NotifyInterfaceDown (uint32_t interface);
 
  virtual void NotifyAddAddress (uint32_t interface, IpInterfaceAddress address);
 
  virtual void NotifyRemoveAddress (uint32_t interface, IpInterfaceAddress address);
 
  virtual void PrintRoutingTable (Ptr<OutputStreamWrapper> stream, Time::Unit unit = Time::S) const;
 
  /* From IPv4RoutingProtocol */
  virtual void SetIpv4 (Ptr<Ip> ipv4);
 
  /* From IPv6RoutingProtocol */
  virtual void SetIpv6 (Ptr<Ip> ipv6);
 
  virtual void NotifyAddRoute (IpAddress dst, Ipv6Prefix mask, IpAddress nextHop, uint32_t interface, IpAddress prefixToUse = IpAddress::GetZero ());
 
  virtual void NotifyRemoveRoute (IpAddress dst, Ipv6Prefix mask, IpAddress nextHop, uint32_t interface, IpAddress prefixToUse = IpAddress::GetZero ());
 
  void CheckCacheStateAndFlush (void) const;
 
  void BuildIpAddressToNodeMap (void) const;
 
  static bool g_isCacheDirty;
 
  mutable NixMap_t m_nixCache;
 
  mutable IpRouteMap_t m_ipRouteCache;
 
  Ptr<Ip> m_ip; 
  Ptr<Node> m_node; 
 
  uint32_t m_totalNeighbors;
 
 
  typedef std::unordered_map<IpAddress, ns3::Ptr<ns3::Node>, IpAddressHash > IpAddressToNodeMap;
  static IpAddressToNodeMap g_ipAddressToNodeMap; 
 
  typedef std::unordered_map<Ptr<NetDevice>, Ptr<IpInterface>> NetDeviceToIpInterfaceMap;
  static NetDeviceToIpInterfaceMap g_netdeviceToIpInterfaceMap; 
};
 
 
typedef NixVectorRouting<Ipv4RoutingProtocol> Ipv4NixVectorRouting;
 
typedef NixVectorRouting<Ipv6RoutingProtocol> Ipv6NixVectorRouting;
} // namespace ns3
 
#endif /* NIX_VECTOR_ROUTING_H */