ipv4-static-routing-helper.cc

Go to the documentation of this file.

/*
 * Copyright (c) 2009 University of Washington
 *
 * SPDX-License-Identifier: GPL-2.0-only
 */
 
#include "ipv4-static-routing-helper.h"
 
#include "ns3/assert.h"
#include "ns3/ipv4-address.h"
#include "ns3/ipv4-list-routing.h"
#include "ns3/ipv4-route.h"
#include "ns3/ipv4-routing-protocol.h"
#include "ns3/ipv4.h"
#include "ns3/log.h"
#include "ns3/names.h"
#include "ns3/node.h"
#include "ns3/ptr.h"
 
#include <vector>
 
namespace ns3
{
 
NS_LOG_COMPONENT_DEFINE("Ipv4StaticRoutingHelper");
 
Ipv4StaticRoutingHelper::Ipv4StaticRoutingHelper()
{
}
 
Ipv4StaticRoutingHelper::Ipv4StaticRoutingHelper(const Ipv4StaticRoutingHelper& o)
{
}
 
Ipv4StaticRoutingHelper*
Ipv4StaticRoutingHelper::Copy() const
{
    return new Ipv4StaticRoutingHelper(*this);
}
 
Ptr<Ipv4RoutingProtocol>
Ipv4StaticRoutingHelper::Create(Ptr<Node> node) const
{
    return CreateObject<Ipv4StaticRouting>();
}
 
Ptr<Ipv4StaticRouting>
Ipv4StaticRoutingHelper::GetStaticRouting(Ptr<Ipv4> ipv4) const
{
    NS_LOG_FUNCTION(this);
    Ptr<Ipv4RoutingProtocol> ipv4rp = ipv4->GetRoutingProtocol();
    NS_ASSERT_MSG(ipv4rp, "No routing protocol associated with Ipv4");
    if (DynamicCast<Ipv4StaticRouting>(ipv4rp))
    {
        NS_LOG_LOGIC("Static routing found as the main IPv4 routing protocol.");
        return DynamicCast<Ipv4StaticRouting>(ipv4rp);
    }
    if (DynamicCast<Ipv4ListRouting>(ipv4rp))
    {
        Ptr<Ipv4ListRouting> lrp = DynamicCast<Ipv4ListRouting>(ipv4rp);
        int16_t priority;
        for (uint32_t i = 0; i < lrp->GetNRoutingProtocols(); i++)
        {
            NS_LOG_LOGIC("Searching for static routing in list");
            Ptr<Ipv4RoutingProtocol> temp = lrp->GetRoutingProtocol(i, priority);
            if (DynamicCast<Ipv4StaticRouting>(temp))
            {
                NS_LOG_LOGIC("Found static routing in list");
                return DynamicCast<Ipv4StaticRouting>(temp);
            }
        }
    }
    NS_LOG_LOGIC("Static routing not found");
    return nullptr;
}
 
void
Ipv4StaticRoutingHelper::AddMulticastRoute(Ptr<Node> n,
                                           Ipv4Address source,
                                           Ipv4Address group,
                                           Ptr<NetDevice> input,
                                           NetDeviceContainer output)
{
    Ptr<Ipv4> ipv4 = n->GetObject<Ipv4>();
 
    // We need to convert the NetDeviceContainer to an array of interface
    // numbers
    std::vector<uint32_t> outputInterfaces;
    for (auto i = output.Begin(); i != output.End(); ++i)
    {
        Ptr<NetDevice> nd = *i;
        int32_t interface = ipv4->GetInterfaceForDevice(nd);
        NS_ASSERT_MSG(interface >= 0,
                      "Ipv4StaticRoutingHelper::AddMulticastRoute(): "
                      "Expected an interface associated with the device nd");
        outputInterfaces.push_back(interface);
    }
 
    int32_t inputInterface = ipv4->GetInterfaceForDevice(input);
    NS_ASSERT_MSG(inputInterface >= 0,
                  "Ipv4StaticRoutingHelper::AddMulticastRoute(): "
                  "Expected an interface associated with the device input");
    Ipv4StaticRoutingHelper helper;
    Ptr<Ipv4StaticRouting> ipv4StaticRouting = helper.GetStaticRouting(ipv4);
    if (!ipv4StaticRouting)
    {
        NS_ASSERT_MSG(ipv4StaticRouting,
                      "Ipv4StaticRoutingHelper::SetDefaultMulticastRoute(): "
                      "Expected an Ipv4StaticRouting associated with this node");
    }
    ipv4StaticRouting->AddMulticastRoute(source, group, inputInterface, outputInterfaces);
}
 
void
Ipv4StaticRoutingHelper::AddMulticastRoute(Ptr<Node> n,
                                           Ipv4Address source,
                                           Ipv4Address group,
                                           std::string inputName,
                                           NetDeviceContainer output)
{
    Ptr<NetDevice> input = Names::Find<NetDevice>(inputName);
    AddMulticastRoute(n, source, group, input, output);
}
 
void
Ipv4StaticRoutingHelper::AddMulticastRoute(std::string nName,
                                           Ipv4Address source,
                                           Ipv4Address group,
                                           Ptr<NetDevice> input,
                                           NetDeviceContainer output)
{
    Ptr<Node> n = Names::Find<Node>(nName);
    AddMulticastRoute(n, source, group, input, output);
}
 
void
Ipv4StaticRoutingHelper::AddMulticastRoute(std::string nName,
                                           Ipv4Address source,
                                           Ipv4Address group,
                                           std::string inputName,
                                           NetDeviceContainer output)
{
    Ptr<NetDevice> input = Names::Find<NetDevice>(inputName);
    Ptr<Node> n = Names::Find<Node>(nName);
    AddMulticastRoute(n, source, group, input, output);
}
 
void
Ipv4StaticRoutingHelper::SetDefaultMulticastRoute(Ptr<Node> n, Ptr<NetDevice> nd)
{
    Ptr<Ipv4> ipv4 = n->GetObject<Ipv4>();
    int32_t interfaceSrc = ipv4->GetInterfaceForDevice(nd);
    NS_ASSERT_MSG(interfaceSrc >= 0,
                  "Ipv4StaticRoutingHelper::SetDefaultMulticastRoute(): "
                  "Expected an interface associated with the device");
    Ipv4StaticRoutingHelper helper;
    Ptr<Ipv4StaticRouting> ipv4StaticRouting = helper.GetStaticRouting(ipv4);
    if (!ipv4StaticRouting)
    {
        NS_ASSERT_MSG(ipv4StaticRouting,
                      "Ipv4StaticRoutingHelper::SetDefaultMulticastRoute(): "
                      "Expected an Ipv4StaticRouting associated with this node");
    }
    ipv4StaticRouting->SetDefaultMulticastRoute(interfaceSrc);
}
 
void
Ipv4StaticRoutingHelper::SetDefaultMulticastRoute(Ptr<Node> n, std::string ndName)
{
    Ptr<NetDevice> nd = Names::Find<NetDevice>(ndName);
    SetDefaultMulticastRoute(n, nd);
}
 
void
Ipv4StaticRoutingHelper::SetDefaultMulticastRoute(std::string nName, Ptr<NetDevice> nd)
{
    Ptr<Node> n = Names::Find<Node>(nName);
    SetDefaultMulticastRoute(n, nd);
}
 
void
Ipv4StaticRoutingHelper::SetDefaultMulticastRoute(std::string nName, std::string ndName)
{
    Ptr<Node> n = Names::Find<Node>(nName);
    Ptr<NetDevice> nd = Names::Find<NetDevice>(ndName);
    SetDefaultMulticastRoute(n, nd);
}
 
} // namespace ns3