A Discrete-Event Network Simulator
API
realtime-fd2fd-onoff.cc
Go to the documentation of this file.
1/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2012 University of Washington, 2012 INRIA
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: Alina Quereilhac <alina.quereilhac@inria.fr>
19 *
20 */
21
22//
23// node 0 node 1
24// +----------------+ +----------------+
25// | ns-3 TCP | | ns-3 TCP |
26// +----------------+ +----------------+
27// | 10.1.1.1 | | 10.1.1.2 |
28// +----------------+ socketpair +----------------+
29// | fd-net-device |--------------| fd-net-device |
30// +----------------+ +----------------+
31//
32// This example is aimed at meassuring the thoughput of the FdNetDevice
33// in a pure simulation. For this purpose two FdNetDevices, attached to
34// different nodes but in a same simulation, are connected using a socket pair.
35// TCP traffic is sent at a saturating data rate. Then the thoughput can
36// be obtained from the generated .pcap files.
37//
38// Steps to run the experiment:
39//
40// $ ./ns3 run="fd2fd-onoff"
41//
42
43#include <sys/socket.h>
44#include <errno.h>
45
46#include "ns3/core-module.h"
47#include "ns3/network-module.h"
48#include "ns3/internet-module.h"
49#include "ns3/fd-net-device-module.h"
50#include "ns3/applications-module.h"
51
52using namespace ns3;
53
54NS_LOG_COMPONENT_DEFINE ("RealtimeFdNetDeviceSaturationExample");
55
56int
57main (int argc, char *argv[])
58{
59 CommandLine cmd (__FILE__);
60 cmd.Parse (argc, argv);
61
62 uint16_t sinkPort = 8000;
63 uint32_t packetSize = 10000; // bytes
64 std::string dataRate("1000Mb/s");
65
66 GlobalValue::Bind ("SimulatorImplementationType", StringValue ("ns3::RealtimeSimulatorImpl"));
67 GlobalValue::Bind ("ChecksumEnabled", BooleanValue (true));
68
69 NS_LOG_INFO ("Create Node");
71 nodes.Create (2);
72
73 NS_LOG_INFO ("Create Device");
76
77 int sv[2];
78 if (socketpair (AF_UNIX, SOCK_DGRAM, 0, sv) < 0)
79 {
80 NS_FATAL_ERROR ("Error creating pipe=" << strerror (errno));
81 }
82
83 Ptr<NetDevice> d1 = devices.Get (0);
84 Ptr<FdNetDevice> clientDevice = d1->GetObject<FdNetDevice> ();
85 clientDevice->SetFileDescriptor (sv[0]);
86
87 Ptr<NetDevice> d2 = devices.Get (1);
88 Ptr<FdNetDevice> serverDevice = d2->GetObject<FdNetDevice> ();
89 serverDevice->SetFileDescriptor (sv[1]);
90
91 NS_LOG_INFO ("Add Internet Stack");
92 InternetStackHelper internetStackHelper;
93 internetStackHelper.SetIpv4StackInstall(true);
94 internetStackHelper.Install (nodes);
95
96 NS_LOG_INFO ("Create IPv4 Interface");
97 Ipv4AddressHelper addresses;
98 addresses.SetBase ("10.0.0.0", "255.255.255.0");
100
101 Ptr<Node> clientNode = nodes.Get (0);
102 Ipv4Address serverIp = interfaces.GetAddress (1);
103 Ptr<Node> serverNode = nodes.Get (1);
104
105 // server
106 Address sinkLocalAddress (InetSocketAddress (serverIp, sinkPort));
107 PacketSinkHelper sinkHelper ("ns3::TcpSocketFactory", sinkLocalAddress);
108 ApplicationContainer sinkApp = sinkHelper.Install (serverNode);
109 sinkApp.Start (Seconds (0.0));
110 sinkApp.Stop (Seconds (40.0));
111 fd.EnablePcap ("rt-fd2fd-onoff-server", serverDevice);
112
113 // client
114 AddressValue serverAddress (InetSocketAddress (serverIp, sinkPort));
115 OnOffHelper onoff ("ns3::TcpSocketFactory", Address ());
116 onoff.SetAttribute ("Remote", serverAddress);
117 onoff.SetAttribute ("OnTime", StringValue ("ns3::ConstantRandomVariable[Constant=1]"));
118 onoff.SetAttribute ("OffTime", StringValue ("ns3::ConstantRandomVariable[Constant=0]"));
119 onoff.SetAttribute ("DataRate", DataRateValue (dataRate));
120 onoff.SetAttribute ("PacketSize", UintegerValue (packetSize));
121 ApplicationContainer clientApps = onoff.Install (clientNode);
122 clientApps.Start (Seconds (1.0));
123 clientApps.Stop (Seconds (39.0));
124 fd.EnablePcap ("rt-fd2fd-onoff-client", clientDevice);
125
126 Simulator::Stop (Seconds (40.0));
127 Simulator::Run ();
128 Simulator::Destroy ();
129}
a polymophic address class
Definition: address.h:91
AttributeValue implementation for Address.
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.
AttributeValue implementation for Boolean.
Definition: boolean.h:37
Parse command-line arguments.
Definition: command-line.h:229
AttributeValue implementation for DataRate.
build a set of FdNetDevice objects Normally we eschew multiple inheritance, however,...
virtual NetDeviceContainer Install(Ptr< Node > node) const
This method creates a FdNetDevice and associates it to a node.
a NetDevice to read/write network traffic from/into a file descriptor.
Definition: fd-net-device.h:85
an Inet address class
aggregate IP/TCP/UDP functionality to existing Nodes.
void SetIpv4StackInstall(bool enable)
Enable/disable IPv4 stack install.
void Install(std::string nodeName) const
Aggregate implementations of the ns3::Ipv4, ns3::Ipv6, ns3::Udp, and ns3::Tcp classes onto the provid...
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
void SetBase(Ipv4Address network, Ipv4Mask mask, Ipv4Address base="0.0.0.1")
Set the base network number, network mask and base address.
Ipv4InterfaceContainer Assign(const NetDeviceContainer &c)
Assign IP addresses to the net devices specified in the container based on the current network prefix...
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:41
holds a vector of std::pair of Ptr<Ipv4> and interface index.
holds a vector of ns3::NetDevice pointers
keep track of a set of node pointers.
Ptr< T > GetObject(void) const
Get a pointer to the requested aggregated Object.
Definition: object.h:470
A helper to make it easier to instantiate an ns3::OnOffApplication on a set of nodes.
Definition: on-off-helper.h:43
A helper to make it easier to instantiate an ns3::PacketSinkApplication on a set of nodes.
void EnablePcap(std::string prefix, Ptr< NetDevice > nd, bool promiscuous=false, bool explicitFilename=false)
Enable pcap output the indicated net device.
Hold variables of type string.
Definition: string.h:41
Hold an unsigned integer type.
Definition: uinteger.h:44
#define NS_FATAL_ERROR(msg)
Report a fatal error with a message and terminate.
Definition: fatal-error.h:165
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:205
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition: log.h:281
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1244
clientApps
Definition: first.py:61
devices
Definition: first.py:39
nodes
Definition: first.py:32
interfaces
Definition: first.py:48
Every class exported by the ns3 library is enclosed in the ns3 namespace.
cmd
Definition: second.py:35
static const uint32_t packetSize
Packet size generated at the AP.