A Discrete-Event Network Simulator
API
simple-alternate-routing.cc
Go to the documentation of this file.
1 /*
2  * This program is free software; you can redistribute it and/or modify
3  * it under the terms of the GNU General Public License version 2 as
4  * published by the Free Software Foundation;
5  *
6  * This program is distributed in the hope that it will be useful,
7  * but WITHOUT ANY WARRANTY; without even the implied warranty of
8  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9  * GNU General Public License for more details.
10  *
11  * You should have received a copy of the GNU General Public License
12  * along with this program; if not, write to the Free Software
13  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
14  *
15  */
16 
17 //
18 // Network topology
19 //
20 // n0
21 // \ 5 Mb/s, 2ms
22 // \ 1.5Mb/s, 10ms
23 // n2 ------------------------n3
24 // / /
25 // / 5 Mb/s, 2ms /
26 // n1--------------------------
27 // 1.5 Mb/s, 100ms
28 //
29 // this is a modification of simple-global-routing to allow for
30 // a single hop but higher-cost path between n1 and n3
31 //
32 // - Tracing of queues and packet receptions to file "simple-rerouting.tr"
33 
34 #include "ns3/applications-module.h"
35 #include "ns3/core-module.h"
36 #include "ns3/internet-module.h"
37 #include "ns3/ipv4-global-routing-helper.h"
38 #include "ns3/network-module.h"
39 #include "ns3/point-to-point-module.h"
40 
41 #include <cassert>
42 #include <fstream>
43 #include <iostream>
44 #include <string>
45 
46 using namespace ns3;
47 
48 NS_LOG_COMPONENT_DEFINE("SimpleAlternateRoutingExample");
49 
50 int
51 main(int argc, char* argv[])
52 {
53  // Users may find it convenient to turn on explicit debugging
54  // for selected modules; the below lines suggest how to do this
55 #if 0
56  LogComponentEnable ("GlobalRoutingHelper", LOG_LOGIC);
57  LogComponentEnable ("GlobalRouter", LOG_LOGIC);
58 #endif
59 
60  Config::SetDefault("ns3::OnOffApplication::PacketSize", UintegerValue(210));
61  Config::SetDefault("ns3::OnOffApplication::DataRate", StringValue("300b/s"));
62 
63  // The below metric, if set to 3 or higher, will cause packets between
64  // n1 and n3 to take the 2-hop route through n2
65 
66  CommandLine cmd(__FILE__);
67  //
68  // Additionally, we plumb this metric into the default value / command
69  // line argument system as well, for exemplary purposes. This means
70  // that it can be resettable at the command-line to the program,
71  // rather than recompiling
72  // e.g. ns3 --run "simple-alternate-routing --AlternateCost=5"
73  uint16_t sampleMetric = 1;
74  cmd.AddValue("AlternateCost",
75  "This metric is used in the example script between n3 and n1 ",
76  sampleMetric);
77 
78  // Allow the user to override any of the defaults and the above
79  // DefaultValue::Bind ()s at run-time, via command-line arguments
80  cmd.Parse(argc, argv);
81 
82  // Here, we will explicitly create four nodes. In more sophisticated
83  // topologies, we could configure a node factory.
84  NS_LOG_INFO("Create nodes.");
85  NodeContainer c;
86  c.Create(4);
87  NodeContainer n0n2 = NodeContainer(c.Get(0), c.Get(2));
88  NodeContainer n1n2 = NodeContainer(c.Get(1), c.Get(2));
89  NodeContainer n3n2 = NodeContainer(c.Get(3), c.Get(2));
90  NodeContainer n1n3 = NodeContainer(c.Get(1), c.Get(3));
91 
92  // We create the channels first without any IP addressing information
93  NS_LOG_INFO("Create channels.");
95  p2p.SetDeviceAttribute("DataRate", StringValue("5Mbps"));
96  p2p.SetChannelAttribute("Delay", StringValue("2ms"));
97  NetDeviceContainer d0d2 = p2p.Install(n0n2);
98 
99  NetDeviceContainer d1d2 = p2p.Install(n1n2);
100 
101  p2p.SetDeviceAttribute("DataRate", StringValue("1500kbps"));
102  p2p.SetChannelAttribute("Delay", StringValue("10ms"));
103  NetDeviceContainer d3d2 = p2p.Install(n3n2);
104 
105  p2p.SetChannelAttribute("Delay", StringValue("100ms"));
106  NetDeviceContainer d1d3 = p2p.Install(n1n3);
107 
109  internet.Install(c);
110 
111  // Later, we add IP addresses. The middle two octets correspond to
112  // the channel number.
113  NS_LOG_INFO("Assign IP Addresses.");
115  ipv4.SetBase("10.0.0.0", "255.255.255.0");
116  ipv4.Assign(d0d2);
117 
118  ipv4.SetBase("10.1.1.0", "255.255.255.0");
119  Ipv4InterfaceContainer i1i2 = ipv4.Assign(d1d2);
120 
121  ipv4.SetBase("10.2.2.0", "255.255.255.0");
122  ipv4.Assign(d3d2);
123 
124  ipv4.SetBase("10.3.3.0", "255.255.255.0");
125  Ipv4InterfaceContainer i1i3 = ipv4.Assign(d1d3);
126 
127  i1i3.SetMetric(0, sampleMetric);
128  i1i3.SetMetric(1, sampleMetric);
129 
130  // Create router nodes, initialize routing database and set up the routing
131  // tables in the nodes.
133 
134  // Create the OnOff application to send UDP datagrams
135  NS_LOG_INFO("Create Application.");
136  uint16_t port = 9; // Discard port (RFC 863)
137 
138  // Create a flow from n3 to n1, starting at time 1.1 seconds
139  OnOffHelper onoff("ns3::UdpSocketFactory",
141  onoff.SetConstantRate(DataRate("300b/s"));
142 
143  ApplicationContainer apps = onoff.Install(c.Get(3));
144  apps.Start(Seconds(1.1));
145  apps.Stop(Seconds(10.0));
146 
147  // Create a packet sink to receive these packets
148  PacketSinkHelper sink("ns3::UdpSocketFactory",
150  apps = sink.Install(c.Get(1));
151  apps.Start(Seconds(1.1));
152  apps.Stop(Seconds(10.0));
153 
154  AsciiTraceHelper ascii;
155  p2p.EnableAsciiAll(ascii.CreateFileStream("simple-alternate-routing.tr"));
156  p2p.EnablePcapAll("simple-alternate-routing");
157 
158  NS_LOG_INFO("Run Simulation.");
159  Simulator::Run();
161  NS_LOG_INFO("Done.");
162 
163  return 0;
164 }
NodeContainer n1n2
Nodecontainer n1 + n2.
Ipv4InterfaceContainer i1i2
IPv4 interface container i1 + i2.
NodeContainer n0n2
Nodecontainer n0 + n2.
a polymophic address class
Definition: address.h:101
holds a vector of ns3::Application pointers.
void Start(Time start) const
Start all of the Applications in this container at the start time given as a parameter.
void Stop(Time stop) const
Arrange for all of the Applications in this container to Stop() at the Time given as a parameter.
Manage ASCII trace files for device models.
Definition: trace-helper.h:174
Ptr< OutputStreamWrapper > CreateFileStream(std::string filename, std::ios::openmode filemode=std::ios::out)
Create and initialize an output stream object we'll use to write the traced bits.
Parse command-line arguments.
Definition: command-line.h:232
an Inet address class
aggregate IP/TCP/UDP functionality to existing Nodes.
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
static Ipv4Address GetAny()
static void PopulateRoutingTables()
Build a routing database and initialize the routing tables of the nodes in the simulation.
holds a vector of std::pair of Ptr<Ipv4> and interface index.
void SetMetric(uint32_t i, uint16_t metric)
Set a metric for the given interface.
Ipv4Address GetAddress(uint32_t i, uint32_t j=0) const
holds a vector of ns3::NetDevice pointers
keep track of a set of node pointers.
void Create(uint32_t n)
Create n nodes and append pointers to them to the end of this NodeContainer.
Ptr< Node > Get(uint32_t i) const
Get the Ptr<Node> stored in this container at a given index.
A helper to make it easier to instantiate an ns3::OnOffApplication on a set of nodes.
Definition: on-off-helper.h:44
A helper to make it easier to instantiate an ns3::PacketSinkApplication on a set of nodes.
Build a set of PointToPointNetDevice objects.
static void Destroy()
Execute the events scheduled with ScheduleDestroy().
Definition: simulator.cc:142
static void Run()
Run the simulation.
Definition: simulator.cc:178
Hold variables of type string.
Definition: string.h:56
Hold an unsigned integer type.
Definition: uinteger.h:45
uint16_t port
Definition: dsdv-manet.cc:44
void SetDefault(std::string name, const AttributeValue &value)
Definition: config.cc:890
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition: log.h:275
void(* DataRate)(DataRate oldValue, DataRate newValue)
TracedValue callback signature for DataRate.
Definition: data-rate.h:327
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1326
Every class exported by the ns3 library is enclosed in the ns3 namespace.
void LogComponentEnable(const std::string &name, LogLevel level)
Enable the logging output associated with that log component.
Definition: log.cc:302
@ LOG_LOGIC
Debugging logs for key branches and decisions in a function.
Definition: log.h:109
cmd
Definition: second.py:40
Ptr< PacketSink > sink
Pointer to the packet sink application.
Definition: wifi-tcp.cc:55