A Discrete-Event Network Simulator
API
ripng-helper.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2014 Universita' di Firenze, Italy
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation;
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, write to the Free Software
15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16  *
17  * Author: Tommaso Pecorella <tommaso.pecorella@unifi.it>
18  */
19 
20 #include "ripng-helper.h"
21 
22 #include "ns3/ipv6-list-routing.h"
23 #include "ns3/node-list.h"
24 #include "ns3/node.h"
25 #include "ns3/ripng.h"
26 
27 #include <map>
28 
29 namespace ns3
30 {
31 
33 {
34  m_factory.SetTypeId("ns3::RipNg");
35 }
36 
38  : m_factory(o.m_factory)
39 {
42 }
43 
45 {
46  m_interfaceExclusions.clear();
47  m_interfaceMetrics.clear();
48 }
49 
52 {
53  return new RipNgHelper(*this);
54 }
55 
58 {
59  Ptr<RipNg> ripng = m_factory.Create<RipNg>();
60 
61  auto it = m_interfaceExclusions.find(node);
62 
63  if (it != m_interfaceExclusions.end())
64  {
65  ripng->SetInterfaceExclusions(it->second);
66  }
67 
68  auto iter = m_interfaceMetrics.find(node);
69 
70  if (iter != m_interfaceMetrics.end())
71  {
72  for (auto subiter = iter->second.begin(); subiter != iter->second.end(); subiter++)
73  {
74  ripng->SetInterfaceMetric(subiter->first, subiter->second);
75  }
76  }
77 
78  node->AggregateObject(ripng);
79  return ripng;
80 }
81 
82 void
83 RipNgHelper::Set(std::string name, const AttributeValue& value)
84 {
85  m_factory.Set(name, value);
86 }
87 
88 int64_t
90 {
91  int64_t currentStream = stream;
92  Ptr<Node> node;
93  for (auto i = c.Begin(); i != c.End(); ++i)
94  {
95  node = (*i);
96  Ptr<Ipv6> ipv6 = node->GetObject<Ipv6>();
97  NS_ASSERT_MSG(ipv6, "Ipv6 not installed on node");
98  Ptr<Ipv6RoutingProtocol> proto = ipv6->GetRoutingProtocol();
99  NS_ASSERT_MSG(proto, "Ipv6 routing not installed on node");
100  Ptr<RipNg> ripng = DynamicCast<RipNg>(proto);
101  if (ripng)
102  {
103  currentStream += ripng->AssignStreams(currentStream);
104  continue;
105  }
106  // RIPng may also be in a list
107  Ptr<Ipv6ListRouting> list = DynamicCast<Ipv6ListRouting>(proto);
108  if (list)
109  {
110  int16_t priority;
111  Ptr<Ipv6RoutingProtocol> listProto;
112  Ptr<RipNg> listRipng;
113  for (uint32_t i = 0; i < list->GetNRoutingProtocols(); i++)
114  {
115  listProto = list->GetRoutingProtocol(i, priority);
116  listRipng = DynamicCast<RipNg>(listProto);
117  if (listRipng)
118  {
119  currentStream += listRipng->AssignStreams(currentStream);
120  break;
121  }
122  }
123  }
124  }
125  return (currentStream - stream);
126 }
127 
128 void
129 RipNgHelper::SetDefaultRouter(Ptr<Node> node, Ipv6Address nextHop, uint32_t interface)
130 {
131  Ptr<Ipv6> ipv6 = node->GetObject<Ipv6>();
132  NS_ASSERT_MSG(ipv6, "Ipv6 not installed on node");
133  Ptr<Ipv6RoutingProtocol> proto = ipv6->GetRoutingProtocol();
134  NS_ASSERT_MSG(proto, "Ipv6 routing not installed on node");
135  Ptr<RipNg> ripng = DynamicCast<RipNg>(proto);
136  if (ripng)
137  {
138  ripng->AddDefaultRouteTo(nextHop, interface);
139  }
140  // RIPng may also be in a list
141  Ptr<Ipv6ListRouting> list = DynamicCast<Ipv6ListRouting>(proto);
142  if (list)
143  {
144  int16_t priority;
145  Ptr<Ipv6RoutingProtocol> listProto;
146  Ptr<RipNg> listRipng;
147  for (uint32_t i = 0; i < list->GetNRoutingProtocols(); i++)
148  {
149  listProto = list->GetRoutingProtocol(i, priority);
150  listRipng = DynamicCast<RipNg>(listProto);
151  if (listRipng)
152  {
153  listRipng->AddDefaultRouteTo(nextHop, interface);
154  break;
155  }
156  }
157  }
158 }
159 
160 void
161 RipNgHelper::ExcludeInterface(Ptr<Node> node, uint32_t interface)
162 {
163  auto it = m_interfaceExclusions.find(node);
164 
165  if (it == m_interfaceExclusions.end())
166  {
167  std::set<uint32_t> interfaces;
168  interfaces.insert(interface);
169 
170  m_interfaceExclusions.insert(std::make_pair(node, interfaces));
171  }
172  else
173  {
174  it->second.insert(interface);
175  }
176 }
177 
178 void
179 RipNgHelper::SetInterfaceMetric(Ptr<Node> node, uint32_t interface, uint8_t metric)
180 {
181  m_interfaceMetrics[node][interface] = metric;
182 }
183 
184 } // namespace ns3
Hold a value for an Attribute.
Definition: attribute.h:70
Describes an IPv6 address.
Definition: ipv6-address.h:49
Access to the IPv6 forwarding table, interfaces, and configuration.
Definition: ipv6.h:82
keep track of a set of node pointers.
Iterator End() const
Get an iterator which indicates past-the-last Node in the container.
Iterator Begin() const
Get an iterator which refers to the first Node in the container.
Ptr< Object > Create() const
Create an Object instance of the configured TypeId.
void Set(const std::string &name, const AttributeValue &value, Args &&... args)
Set an attribute to be set during construction.
void SetTypeId(TypeId tid)
Set the TypeId of the Objects to be created by this factory.
Ptr< T > GetObject() const
Get a pointer to the requested aggregated Object.
Definition: object.h:471
void AggregateObject(Ptr< Object > other)
Aggregate two Objects together.
Definition: object.cc:259
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:77
Helper class that adds RIPng routing to nodes.
Definition: ripng-helper.h:44
void SetDefaultRouter(Ptr< Node > node, Ipv6Address nextHop, uint32_t interface)
Install a default route in the node.
void ExcludeInterface(Ptr< Node > node, uint32_t interface)
Exclude an interface from RIPng protocol.
Ptr< Ipv6RoutingProtocol > Create(Ptr< Node > node) const override
Definition: ripng-helper.cc:57
int64_t AssignStreams(NodeContainer c, int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model.
Definition: ripng-helper.cc:89
RipNgHelper * Copy() const override
Definition: ripng-helper.cc:51
void SetInterfaceMetric(Ptr< Node > node, uint32_t interface, uint8_t metric)
Set a metric for an interface.
std::map< Ptr< Node >, std::set< uint32_t > > m_interfaceExclusions
Interface Exclusion set.
Definition: ripng-helper.h:143
void Set(std::string name, const AttributeValue &value)
Definition: ripng-helper.cc:83
~RipNgHelper() override
Definition: ripng-helper.cc:44
std::map< Ptr< Node >, std::map< uint32_t, uint8_t > > m_interfaceMetrics
Interface Metric set.
Definition: ripng-helper.h:144
ObjectFactory m_factory
Object Factory.
Definition: ripng-helper.h:141
RIPng Routing Protocol, defined in RFC 2080.
Definition: ripng.h:178
#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:86
interfaces
Definition: first.py:50
Every class exported by the ns3 library is enclosed in the ns3 namespace.
#define list