A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ipv4-static-routing-helper.cc
Go to the documentation of this file.
1/*
2 * Copyright (c) 2009 University of Washington
3 *
4 * SPDX-License-Identifier: GPL-2.0-only
5 */
6
8
9#include "ns3/assert.h"
10#include "ns3/ipv4-address.h"
11#include "ns3/ipv4-list-routing.h"
12#include "ns3/ipv4-route.h"
13#include "ns3/ipv4-routing-protocol.h"
14#include "ns3/ipv4.h"
15#include "ns3/log.h"
16#include "ns3/names.h"
17#include "ns3/node.h"
18#include "ns3/ptr.h"
19
20#include <vector>
21
22namespace ns3
23{
24
25NS_LOG_COMPONENT_DEFINE("Ipv4StaticRoutingHelper");
26
30
34
37{
38 return new Ipv4StaticRoutingHelper(*this);
39}
40
46
49{
50 NS_LOG_FUNCTION(this);
51 Ptr<Ipv4RoutingProtocol> ipv4rp = ipv4->GetRoutingProtocol();
52 NS_ASSERT_MSG(ipv4rp, "No routing protocol associated with Ipv4");
54 {
55 NS_LOG_LOGIC("Static routing found as the main IPv4 routing protocol.");
56 return DynamicCast<Ipv4StaticRouting>(ipv4rp);
57 }
59 {
61 int16_t priority;
62 for (uint32_t i = 0; i < lrp->GetNRoutingProtocols(); i++)
63 {
64 NS_LOG_LOGIC("Searching for static routing in list");
65 Ptr<Ipv4RoutingProtocol> temp = lrp->GetRoutingProtocol(i, priority);
67 {
68 NS_LOG_LOGIC("Found static routing in list");
70 }
71 }
72 }
73 NS_LOG_LOGIC("Static routing not found");
74 return nullptr;
75}
76
77void
79 Ipv4Address source,
80 Ipv4Address group,
81 Ptr<NetDevice> input,
82 NetDeviceContainer output)
83{
84 Ptr<Ipv4> ipv4 = n->GetObject<Ipv4>();
85
86 // We need to convert the NetDeviceContainer to an array of interface
87 // numbers
88 std::vector<uint32_t> outputInterfaces;
89 for (auto i = output.Begin(); i != output.End(); ++i)
90 {
91 Ptr<NetDevice> nd = *i;
92 int32_t interface = ipv4->GetInterfaceForDevice(nd);
93 NS_ASSERT_MSG(interface >= 0,
94 "Ipv4StaticRoutingHelper::AddMulticastRoute(): "
95 "Expected an interface associated with the device nd");
96 outputInterfaces.push_back(interface);
97 }
98
99 int32_t inputInterface = ipv4->GetInterfaceForDevice(input);
100 NS_ASSERT_MSG(inputInterface >= 0,
101 "Ipv4StaticRoutingHelper::AddMulticastRoute(): "
102 "Expected an interface associated with the device input");
104 Ptr<Ipv4StaticRouting> ipv4StaticRouting = helper.GetStaticRouting(ipv4);
105 if (!ipv4StaticRouting)
106 {
107 NS_ASSERT_MSG(ipv4StaticRouting,
108 "Ipv4StaticRoutingHelper::SetDefaultMulticastRoute(): "
109 "Expected an Ipv4StaticRouting associated with this node");
110 }
111 ipv4StaticRouting->AddMulticastRoute(source, group, inputInterface, outputInterfaces);
112}
113
114void
116 Ipv4Address source,
117 Ipv4Address group,
118 std::string inputName,
119 NetDeviceContainer output)
120{
121 Ptr<NetDevice> input = Names::Find<NetDevice>(inputName);
122 AddMulticastRoute(n, source, group, input, output);
123}
124
125void
127 Ipv4Address source,
128 Ipv4Address group,
129 Ptr<NetDevice> input,
130 NetDeviceContainer output)
131{
132 Ptr<Node> n = Names::Find<Node>(nName);
133 AddMulticastRoute(n, source, group, input, output);
134}
135
136void
138 Ipv4Address source,
139 Ipv4Address group,
140 std::string inputName,
141 NetDeviceContainer output)
142{
143 Ptr<NetDevice> input = Names::Find<NetDevice>(inputName);
144 Ptr<Node> n = Names::Find<Node>(nName);
145 AddMulticastRoute(n, source, group, input, output);
146}
147
148void
150{
151 Ptr<Ipv4> ipv4 = n->GetObject<Ipv4>();
152 int32_t interfaceSrc = ipv4->GetInterfaceForDevice(nd);
153 NS_ASSERT_MSG(interfaceSrc >= 0,
154 "Ipv4StaticRoutingHelper::SetDefaultMulticastRoute(): "
155 "Expected an interface associated with the device");
157 Ptr<Ipv4StaticRouting> ipv4StaticRouting = helper.GetStaticRouting(ipv4);
158 if (!ipv4StaticRouting)
159 {
160 NS_ASSERT_MSG(ipv4StaticRouting,
161 "Ipv4StaticRoutingHelper::SetDefaultMulticastRoute(): "
162 "Expected an Ipv4StaticRouting associated with this node");
163 }
164 ipv4StaticRouting->SetDefaultMulticastRoute(interfaceSrc);
165}
166
167void
173
174void
180
181void
182Ipv4StaticRoutingHelper::SetDefaultMulticastRoute(std::string nName, std::string ndName)
183{
184 Ptr<Node> n = Names::Find<Node>(nName);
187}
188
189} // namespace ns3
Ipv4 addresses are stored in host order in this class.
Access to the IPv4 forwarding table, interfaces, and configuration.
Definition ipv4.h:69
Helper class that adds ns3::Ipv4StaticRouting objects.
Ipv4StaticRoutingHelper * Copy() const override
Ptr< Ipv4StaticRouting > GetStaticRouting(Ptr< Ipv4 > ipv4) const
Try and find the static routing protocol as either the main routing protocol or in the list of routin...
void AddMulticastRoute(Ptr< Node > n, Ipv4Address source, Ipv4Address group, Ptr< NetDevice > input, NetDeviceContainer output)
Add a multicast route to a node and net device using explicit Ptr<Node> and Ptr<NetDevice>
void SetDefaultMulticastRoute(Ptr< Node > n, Ptr< NetDevice > nd)
Add a default route to the static routing protocol to forward packets out a particular interface.
Ptr< Ipv4RoutingProtocol > Create(Ptr< Node > node) const override
static Ptr< T > Find(std::string path)
Given a name path string, look to see if there's an object in the system with that associated to it.
Definition names.h:443
holds a vector of ns3::NetDevice pointers
Iterator Begin() const
Get an iterator which refers to the first NetDevice in the container.
Iterator End() const
Get an iterator which indicates past-the-last NetDevice in the container.
Smart pointer class similar to boost::intrusive_ptr.
#define NS_ASSERT_MSG(condition, message)
At runtime, in debugging builds, if this condition is not true, the program prints the message to out...
Definition assert.h:75
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition log.h:191
#define NS_LOG_LOGIC(msg)
Use NS_LOG to output a message of level LOG_LOGIC.
Definition log.h:271
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
Ptr< T > CreateObject(Args &&... args)
Create an object by type, with varying number of constructor parameters.
Definition object.h:619
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Ptr< T1 > DynamicCast(const Ptr< T2 > &p)
Cast a Ptr.
Definition ptr.h:580