A Discrete-Event Network Simulator
API
traceroute-example.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2019 Ritsumeikan University, Shiga, Japan
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Alberto Gallegos Ramonet <ramonet@fc.ritsumei.ac.jp>
19  *
20  *
21  * TraceRoute application example using AODV routing protocol.
22  *
23  *
24  */
25 
26 #include "ns3/aodv-module.h"
27 #include "ns3/core-module.h"
28 #include "ns3/network-module.h"
29 #include "ns3/internet-module.h"
30 #include "ns3/mobility-module.h"
31 #include "ns3/point-to-point-module.h"
32 #include "ns3/wifi-module.h"
33 #include "ns3/v4traceroute-helper.h"
34 #include <iostream>
35 #include <cmath>
36 
37 using namespace ns3;
38 
55 {
56 public:
64  bool Configure (int argc, char **argv);
66  void Run ();
71  void Report (std::ostream & os);
72 
73 private:
74  // parameters
76  uint32_t size;
78  double step;
80  double totalTime;
82  bool pcap;
91 
92 private:
94  void CreateNodes ();
96  void CreateDevices ();
98  void InstallInternetStack ();
100 
101  void InstallApplications ();
102 };
103 
104 int main (int argc, char **argv)
105 {
106  TracerouteExample test;
107  if (!test.Configure (argc, argv))
108  {
109  NS_FATAL_ERROR ("Configuration failed. Aborted.");
110  }
111 
112  test.Run ();
113  test.Report (std::cout);
114  return 0;
115 }
116 
117 //-----------------------------------------------------------------------------
119  : size (10),
120  step (50),
121  totalTime (100),
122  pcap (false),
123  printRoutes (false)
124 {
125 }
126 
127 bool
128 TracerouteExample::Configure (int argc, char **argv)
129 {
130  // Enable AODV logs by default. Comment this if too noisy
131  // LogComponentEnable("AodvRoutingProtocol", LOG_LEVEL_ALL);
132 
133  SeedManager::SetSeed (12345);
134  CommandLine cmd (__FILE__);
135 
136  cmd.AddValue ("pcap", "Write PCAP traces.", pcap);
137  cmd.AddValue ("printRoutes", "Print routing table dumps.", printRoutes);
138  cmd.AddValue ("size", "Number of nodes.", size);
139  cmd.AddValue ("time", "Simulation time, s.", totalTime);
140  cmd.AddValue ("step", "Grid step, m", step);
141 
142  cmd.Parse (argc, argv);
143  return true;
144 }
145 
146 void
148 {
149  CreateNodes ();
150 
151  CreateDevices ();
152 
154 
156 
157  std::cout << "Starting simulation for " << totalTime << " s ...\n";
158 
159  Simulator::Stop (Seconds (totalTime));
160  Simulator::Run ();
161  Simulator::Destroy ();
162 }
163 
164 void
166 {
167 }
168 
169 void
171 {
172  std::cout << "Creating " << (unsigned)size << " nodes " << step << " m apart.\n";
173  nodes.Create (size);
174  // Name nodes
175  for (uint32_t i = 0; i < size; ++i)
176  {
177  std::ostringstream os;
178  os << "node-" << i;
179  Names::Add (os.str (), nodes.Get (i));
180  }
181  // Create static grid
183  mobility.SetPositionAllocator ("ns3::GridPositionAllocator",
184  "MinX", DoubleValue (0.0),
185  "MinY", DoubleValue (0.0),
186  "DeltaX", DoubleValue (step),
187  "DeltaY", DoubleValue (0),
188  "GridWidth", UintegerValue (size),
189  "LayoutType", StringValue ("RowFirst"));
190  mobility.SetMobilityModel ("ns3::ConstantPositionMobilityModel");
191  mobility.Install (nodes);
192 }
193 
194 void
196 {
197  WifiMacHelper wifiMac;
198  wifiMac.SetType ("ns3::AdhocWifiMac");
199  YansWifiPhyHelper wifiPhy = YansWifiPhyHelper::Default ();
200  YansWifiChannelHelper wifiChannel = YansWifiChannelHelper::Default ();
201  wifiPhy.SetChannel (wifiChannel.Create ());
203  wifi.SetRemoteStationManager ("ns3::ConstantRateWifiManager", "DataMode", StringValue ("OfdmRate6Mbps"), "RtsCtsThreshold", UintegerValue (0));
204  devices = wifi.Install (wifiPhy, wifiMac, nodes);
205 
206  if (pcap)
207  {
208  wifiPhy.EnablePcapAll (std::string ("aodv"));
209  }
210 }
211 
212 void
214 {
215  AodvHelper aodv;
216  // you can configure AODV attributes here using aodv.Set(name, value)
218  stack.SetRoutingHelper (aodv); // has effect on the next Install ()
219  stack.Install (nodes);
221  address.SetBase ("10.0.0.0", "255.0.0.0");
222  interfaces = address.Assign (devices);
223 
224  if (printRoutes)
225  {
226  Ptr<OutputStreamWrapper> routingStream = Create<OutputStreamWrapper> ("aodv.routes", std::ios::out);
227  aodv.PrintRoutingTableAllAt (Seconds (8), routingStream);
228 
229  }
230 }
231 
232 void
234 {
235  V4TraceRouteHelper traceroute (Ipv4Address ("10.0.0.10")); //size - 1
236  traceroute.SetAttribute ("Verbose", BooleanValue (true));
237  ApplicationContainer p = traceroute.Install (nodes.Get (0));
238 
239  // Used when we wish to dump the traceroute results into a file
240 
241  //Ptr<OutputStreamWrapper> printstrm = Create<OutputStreamWrapper> ("mytrace", std::ios::out);
242  //traceroute.PrintTraceRouteAt(nodes.Get(0),printstrm);
243 
244  p.Start (Seconds (0));
245  p.Stop (Seconds (totalTime) - Seconds (0.001));
246 
247 }
248 
holds a vector of ns3::Application pointers.
bool printRoutes
Print aodv routes if true.
AttributeValue implementation for Boolean.
Definition: boolean.h:36
holds a vector of std::pair of Ptr<Ipv4> and interface index.
void Run()
Run simulation.
Hold variables of type string.
Definition: string.h:41
Make it easy to create and manage PHY objects for the YANS model.
void InstallInternetStack()
Create the network.
uint32_t size
Number of nodes.
bool Configure(int argc, char **argv)
Configure script parameters.
aggregate IP/TCP/UDP functionality to existing Nodes.
#define NS_FATAL_ERROR(msg)
Report a fatal error with a message and terminate.
Definition: fatal-error.h:165
cmd
Definition: second.py:35
NetDeviceContainer devices
devices used in the example
helps to create WifiNetDevice objects
Definition: wifi-helper.h:317
stack
Definition: first.py:41
Ptr< YansWifiChannel > Create(void) const
mobility
Definition: third.py:108
void SetAttribute(std::string name, const AttributeValue &value)
Configure traceRoute applications attribute.
void SetChannel(Ptr< YansWifiChannel > channel)
void EnablePcapAll(std::string prefix, bool promiscuous=false)
Enable pcap output on each device (which is of the appropriate type) in the set of all nodes created ...
Ipv4InterfaceContainer interfaces
interfaces used in the example
Hold an unsigned integer type.
Definition: uinteger.h:44
double step
Distance between nodes, meters.
holds a vector of ns3::NetDevice pointers
void Start(Time start)
Arrange for all of the Applications in this container to Start() at the Time given as a parameter...
Parse command-line arguments.
Definition: command-line.h:226
ApplicationContainer Install(NodeContainer nodes) const
Install a TraceRoute application on each Node in the provided NodeContainer.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
keep track of a set of node pointers.
address
Definition: first.py:44
NodeContainer nodes
nodes used in the example
Create a IPv4 traceroute application and associate it to a node.
manage and create wifi channel objects for the YANS model.
create MAC layers for a ns3::WifiNetDevice.
bool pcap
Write per-device PCAP traces if true.
double totalTime
Simulation time, seconds.
void Report(std::ostream &os)
Report results.
virtual void SetType(std::string type, std::string n0="", const AttributeValue &v0=EmptyAttributeValue(), std::string n1="", const AttributeValue &v1=EmptyAttributeValue(), std::string n2="", const AttributeValue &v2=EmptyAttributeValue(), std::string n3="", const AttributeValue &v3=EmptyAttributeValue(), std::string n4="", const AttributeValue &v4=EmptyAttributeValue(), std::string n5="", const AttributeValue &v5=EmptyAttributeValue(), std::string n6="", const AttributeValue &v6=EmptyAttributeValue(), std::string n7="", const AttributeValue &v7=EmptyAttributeValue(), std::string n8="", const AttributeValue &v8=EmptyAttributeValue(), std::string n9="", const AttributeValue &v9=EmptyAttributeValue(), std::string n10="", const AttributeValue &v10=EmptyAttributeValue())
wifi
Definition: third.py:96
Helper class used to assign positions and mobility models to nodes.
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:41
void Stop(Time stop)
Arrange for all of the Applications in this container to Stop() at the Time given as a parameter...
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1278
void CreateNodes()
Create the nodes.
Ptr< Node > Get(uint32_t i) const
Get the Ptr<Node> stored in this container at a given index.
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
void CreateDevices()
Create the devices.
void Create(uint32_t n)
Create n nodes and append pointers to them to the end of this NodeContainer.
Helper class that adds AODV routing to nodes.
Definition: aodv-helper.h:34
void InstallApplications()
Create the simulation applications.
This class can be used to hold variables of floating point type such as &#39;double&#39; or &#39;float&#39;...
Definition: double.h:41
static void PrintRoutingTableAllAt(Time printTime, Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S)
prints the routing tables of all nodes at a particular time.