A Discrete-Event Network Simulator
API
seventh.cc
Go to the documentation of this file.
1/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License version 2 as
5 * published by the Free Software Foundation;
6 *
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
11 *
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15 */
16
17#include <fstream>
18#include "ns3/core-module.h"
19#include "ns3/network-module.h"
20#include "ns3/internet-module.h"
21#include "ns3/applications-module.h"
22#include "ns3/point-to-point-module.h"
23#include "ns3/stats-module.h"
24#include "tutorial-app.h"
25
26using namespace ns3;
27
28NS_LOG_COMPONENT_DEFINE ("SeventhScriptExample");
29
30// ===========================================================================
31//
32// node 0 node 1
33// +----------------+ +----------------+
34// | ns-3 TCP | | ns-3 TCP |
35// +----------------+ +----------------+
36// | 10.1.1.1 | | 10.1.1.2 |
37// +----------------+ +----------------+
38// | point-to-point | | point-to-point |
39// +----------------+ +----------------+
40// | |
41// +---------------------+
42// 5 Mbps, 2 ms
43//
44//
45// We want to look at changes in the ns-3 TCP congestion window. We need
46// to crank up a flow and hook the CongestionWindow attribute on the socket
47// of the sender. Normally one would use an on-off application to generate a
48// flow, but this has a couple of problems. First, the socket of the on-off
49// application is not created until Application Start time, so we wouldn't be
50// able to hook the socket (now) at configuration time. Second, even if we
51// could arrange a call after start time, the socket is not public so we
52// couldn't get at it.
53//
54// So, we can cook up a simple version of the on-off application that does what
55// we want. On the plus side we don't need all of the complexity of the on-off
56// application. On the minus side, we don't have a helper, so we have to get
57// a little more involved in the details, but this is trivial.
58//
59// So first, we create a socket and do the trace connect on it; then we pass
60// this socket into the constructor of our simple application which we then
61// install in the source node.
62//
63// NOTE: If this example gets modified, do not forget to update the .png figure
64// in src/stats/docs/seventh-packet-byte-count.png
65// ===========================================================================
66//
67
68
69static void
71{
72 NS_LOG_UNCOND (Simulator::Now ().GetSeconds () << "\t" << newCwnd);
73 *stream->GetStream () << Simulator::Now ().GetSeconds () << "\t" << oldCwnd << "\t" << newCwnd << std::endl;
74}
75
76static void
78{
79 NS_LOG_UNCOND ("RxDrop at " << Simulator::Now ().GetSeconds ());
80 file->Write (Simulator::Now (), p);
81}
82
83int
84main (int argc, char *argv[])
85{
86 bool useV6 = false;
87
88 CommandLine cmd (__FILE__);
89 cmd.AddValue ("useIpv6", "Use Ipv6", useV6);
90 cmd.Parse (argc, argv);
91
93 nodes.Create (2);
94
96 pointToPoint.SetDeviceAttribute ("DataRate", StringValue ("5Mbps"));
97 pointToPoint.SetChannelAttribute ("Delay", StringValue ("2ms"));
98
100 devices = pointToPoint.Install (nodes);
101
102 Ptr<RateErrorModel> em = CreateObject<RateErrorModel> ();
103 em->SetAttribute ("ErrorRate", DoubleValue (0.00001));
104 devices.Get (1)->SetAttribute ("ReceiveErrorModel", PointerValue (em));
105
107 stack.Install (nodes);
108
109 uint16_t sinkPort = 8080;
110 Address sinkAddress;
111 Address anyAddress;
112 std::string probeType;
113 std::string tracePath;
114 if (useV6 == false)
115 {
117 address.SetBase ("10.1.1.0", "255.255.255.0");
119 sinkAddress = InetSocketAddress (interfaces.GetAddress (1), sinkPort);
120 anyAddress = InetSocketAddress (Ipv4Address::GetAny (), sinkPort);
121 probeType = "ns3::Ipv4PacketProbe";
122 tracePath = "/NodeList/*/$ns3::Ipv4L3Protocol/Tx";
123 }
124 else
125 {
127 address.SetBase ("2001:0000:f00d:cafe::", Ipv6Prefix (64));
129 sinkAddress = Inet6SocketAddress (interfaces.GetAddress (1,1), sinkPort);
130 anyAddress = Inet6SocketAddress (Ipv6Address::GetAny (), sinkPort);
131 probeType = "ns3::Ipv6PacketProbe";
132 tracePath = "/NodeList/*/$ns3::Ipv6L3Protocol/Tx";
133 }
134
135 PacketSinkHelper packetSinkHelper ("ns3::TcpSocketFactory", anyAddress);
136 ApplicationContainer sinkApps = packetSinkHelper.Install (nodes.Get (1));
137 sinkApps.Start (Seconds (0.));
138 sinkApps.Stop (Seconds (20.));
139
140 Ptr<Socket> ns3TcpSocket = Socket::CreateSocket (nodes.Get (0), TcpSocketFactory::GetTypeId ());
141
142 Ptr<TutorialApp> app = CreateObject<TutorialApp> ();
143 app->Setup (ns3TcpSocket, sinkAddress, 1040, 1000, DataRate ("1Mbps"));
144 nodes.Get (0)->AddApplication (app);
145 app->SetStartTime (Seconds (1.));
146 app->SetStopTime (Seconds (20.));
147
148 AsciiTraceHelper asciiTraceHelper;
149 Ptr<OutputStreamWrapper> stream = asciiTraceHelper.CreateFileStream ("seventh.cwnd");
150 ns3TcpSocket->TraceConnectWithoutContext ("CongestionWindow", MakeBoundCallback (&CwndChange, stream));
151
152 PcapHelper pcapHelper;
153 Ptr<PcapFileWrapper> file = pcapHelper.CreateFile ("seventh.pcap", std::ios::out, PcapHelper::DLT_PPP);
154 devices.Get (1)->TraceConnectWithoutContext ("PhyRxDrop", MakeBoundCallback (&RxDrop, file));
155
156 // Use GnuplotHelper to plot the packet byte count over time
157 GnuplotHelper plotHelper;
158
159 // Configure the plot. The first argument is the file name prefix
160 // for the output files generated. The second, third, and fourth
161 // arguments are, respectively, the plot title, x-axis, and y-axis labels
162 plotHelper.ConfigurePlot ("seventh-packet-byte-count",
163 "Packet Byte Count vs. Time",
164 "Time (Seconds)",
165 "Packet Byte Count");
166
167 // Specify the probe type, trace source path (in configuration namespace), and
168 // probe output trace source ("OutputBytes") to plot. The fourth argument
169 // specifies the name of the data series label on the plot. The last
170 // argument formats the plot by specifying where the key should be placed.
171 plotHelper.PlotProbe (probeType,
172 tracePath,
173 "OutputBytes",
174 "Packet Byte Count",
175 GnuplotAggregator::KEY_BELOW);
176
177 // Use FileHelper to write out the packet byte count over time
178 FileHelper fileHelper;
179
180 // Configure the file to be written, and the formatting of output data.
181 fileHelper.ConfigureFile ("seventh-packet-byte-count",
182 FileAggregator::FORMATTED);
183
184 // Set the labels for this formatted output file.
185 fileHelper.Set2dFormat ("Time (Seconds) = %.3e\tPacket Byte Count = %.0f");
186
187 // Specify the probe type, trace source path (in configuration namespace), and
188 // probe output trace source ("OutputBytes") to write.
189 fileHelper.WriteProbe (probeType,
190 tracePath,
191 "OutputBytes");
192
193 Simulator::Stop (Seconds (20));
195 Simulator::Destroy ();
196
197 return 0;
198}
199
void Run(ObjectFactory &factory, uint32_t pop, uint32_t total, uint32_t runs, Ptr< RandomVariableStream > eventStream, bool calRev)
Perform the runs for a single scheduler type.
a polymophic address class
Definition: address.h:91
holds a vector of ns3::Application pointers.
void Start(Time start)
Arrange for all of the Applications in this container to Start() at the Time given as a parameter.
void Stop(Time stop)
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:163
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:229
Class for representing data rates.
Definition: data-rate.h:89
This class can be used to hold variables of floating point type such as 'double' or 'float'.
Definition: double.h:41
Helper class used to put data values into a file.
Definition: file-helper.h:39
void Set2dFormat(const std::string &format)
Sets the 2D format string for the C-style sprintf() function.
Definition: file-helper.cc:379
void WriteProbe(const std::string &typeId, const std::string &path, const std::string &probeTraceSource)
Definition: file-helper.cc:90
void ConfigureFile(const std::string &outputFileNameWithoutExtension, enum FileAggregator::FileType fileType=FileAggregator::SPACE_SEPARATED)
Definition: file-helper.cc:68
Helper class used to make gnuplot plots.
void ConfigurePlot(const std::string &outputFileNameWithoutExtension, const std::string &title, const std::string &xLegend, const std::string &yLegend, const std::string &terminalType="png")
void PlotProbe(const std::string &typeId, const std::string &path, const std::string &probeTraceSource, const std::string &title, enum GnuplotAggregator::KeyLocation keyLocation=GnuplotAggregator::KEY_INSIDE)
An Inet6 address class.
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.
holds a vector of std::pair of Ptr<Ipv4> and interface index.
Helper class to auto-assign global IPv6 unicast addresses.
Keep track of a set of IPv6 interfaces.
Describes an IPv6 prefix.
Definition: ipv6-address.h:456
holds a vector of ns3::NetDevice pointers
keep track of a set of node pointers.
bool TraceConnectWithoutContext(std::string name, const CallbackBase &cb)
Connect a TraceSource to a Callback without a context.
Definition: object-base.cc:364
void SetAttribute(std::string name, const AttributeValue &value)
Set a single attribute, raising fatal errors if unsuccessful.
Definition: object-base.cc:256
std::ostream * GetStream(void)
Return a pointer to an ostream previously set in the wrapper.
A helper to make it easier to instantiate an ns3::PacketSinkApplication on a set of nodes.
Manage pcap files for device models.
Definition: trace-helper.h:39
Ptr< PcapFileWrapper > CreateFile(std::string filename, std::ios::openmode filemode, DataLinkType dataLinkType, uint32_t snapLen=std::numeric_limits< uint32_t >::max(), int32_t tzCorrection=0)
Create and initialize a pcap file.
Definition: trace-helper.cc:49
Build a set of PointToPointNetDevice objects.
Hold objects of type Ptr<T>.
Definition: pointer.h:37
Hold variables of type string.
Definition: string.h:41
double GetSeconds(void) const
Get an approximation of the time stored in this instance in the indicated unit.
Definition: nstime.h:380
#define NS_LOG_UNCOND(msg)
Output the requested message unconditionally.
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:205
Callback< R > MakeBoundCallback(R(*fnPtr)(TX), ARG a1)
Make Callbacks with one bound argument.
Definition: callback.h:1709
Time Now(void)
create an ns3::Time instance which contains the current simulation time.
Definition: simulator.cc:287
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1245
address
Definition: first.py:40
pointToPoint
Definition: first.py:31
devices
Definition: first.py:35
stack
Definition: first.py:37
nodes
Definition: first.py:28
interfaces
Definition: first.py:44
Every class exported by the ns3 library is enclosed in the ns3 namespace.
cmd
Definition: second.py:43
static void CwndChange(Ptr< OutputStreamWrapper > stream, uint32_t oldCwnd, uint32_t newCwnd)
Definition: seventh.cc:70
static void RxDrop(Ptr< PcapFileWrapper > file, Ptr< const Packet > p)
Definition: seventh.cc:77