A Discrete-Event Network Simulator
API
simple-mpdu-aggregation.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2015 Sébastien Deronne
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: Sébastien Deronne <sebastien.deronne@gmail.com>
19  */
20 
21 #include "ns3/core-module.h"
22 #include "ns3/network-module.h"
23 #include "ns3/applications-module.h"
24 #include "ns3/wifi-module.h"
25 #include "ns3/mobility-module.h"
26 #include "ns3/ipv4-global-routing-helper.h"
27 #include "ns3/internet-module.h"
28 
29 // This is a simple example in order to show how 802.11n MPDU aggregation feature works.
30 // The throughput is obtained for a given number of aggregated MPDUs.
31 //
32 // The number of aggregated MPDUs can be chosen by the user through the nMpdus attibute.
33 // A value of 1 means that no MPDU aggregation is performed.
34 //
35 // Example: ./waf --run "simple-mpdu-aggregation --nMpdus=64"
36 //
37 // Network topology:
38 //
39 // Wifi 192.168.1.0
40 //
41 // AP
42 // * *
43 // | |
44 // n1 n2
45 //
46 // Packets in this simulation aren't marked with a QosTag so they are considered
47 // belonging to BestEffort Access Class (AC_BE).
48 
49 using namespace ns3;
50 
51 NS_LOG_COMPONENT_DEFINE ("SimpleMpduAggregation");
52 
53 int main (int argc, char *argv[])
54 {
55  uint32_t payloadSize = 1472; //bytes
56  uint64_t simulationTime = 10; //seconds
57  uint32_t nMpdus = 1;
58  bool enableRts = 0;
59 
60  CommandLine cmd;
61  cmd.AddValue("nMpdus", "Number of aggregated MPDUs", nMpdus); //number of aggregated MPDUs specified by the user
62  cmd.AddValue("payloadSize", "Payload size in bytes", payloadSize);
63  cmd.AddValue("enableRts", "Enable RTS/CTS", enableRts);
64  cmd.AddValue("simulationTime", "Simulation time in seconds", simulationTime);
65  cmd.Parse (argc, argv);
66 
67  if(!enableRts)
68  Config::SetDefault ("ns3::WifiRemoteStationManager::RtsCtsThreshold", StringValue ("999999"));
69  else
70  Config::SetDefault ("ns3::WifiRemoteStationManager::RtsCtsThreshold", StringValue ("0"));
71 
72  Config::SetDefault ("ns3::WifiRemoteStationManager::FragmentationThreshold", StringValue ("990000"));
73 
74  NodeContainer wifiStaNode;
75  wifiStaNode.Create (1);
76  NodeContainer wifiApNode;
77  wifiApNode.Create(1);
78 
82  phy.SetChannel (channel.Create());
83 
86  wifi.SetRemoteStationManager ("ns3::ConstantRateWifiManager", "DataMode", StringValue("OfdmRate65MbpsBW20MHz"), "ControlMode", StringValue("OfdmRate6_5MbpsBW20MHz"));
88 
89  Ssid ssid = Ssid ("simple-mpdu-aggregation");
90  mac.SetType ("ns3::StaWifiMac",
91  "Ssid", SsidValue (ssid),
92  "ActiveProbing", BooleanValue (false));
93 
94  if (nMpdus > 1) mac.SetBlockAckThresholdForAc (AC_BE, 2); //enable Block ACK when A-MPDU is enabled (i.e. nMpdus > 1)
95 
96  mac.SetMpduAggregatorForAc (AC_BE,"ns3::MpduStandardAggregator",
97  "MaxAmpduSize", UintegerValue (nMpdus*(payloadSize+100))); //enable MPDU aggregation for AC_BE with a maximum aggregated size of nMpdus*(payloadSize+100) bytes, i.e. nMpdus aggregated packets in an A-MPDU
98 
99  NetDeviceContainer staDevice;
100  staDevice = wifi.Install (phy, mac, wifiStaNode);
101 
102  mac.SetType ("ns3::ApWifiMac",
103  "Ssid", SsidValue (ssid),
104  "BeaconInterval", TimeValue (MicroSeconds(102400)),
105  "BeaconGeneration", BooleanValue (true));
106 
107  if (nMpdus > 1) mac.SetBlockAckThresholdForAc (AC_BE, 2); //enable Block ACK when A-MPDU is enabled (i.e. nMpdus > 1)
108 
109  mac.SetMpduAggregatorForAc (AC_BE,"ns3::MpduStandardAggregator",
110  "MaxAmpduSize", UintegerValue (nMpdus*(payloadSize+100))); //enable MPDU aggregation for AC_BE with a maximum aggregated size of nMpdus*(payloadSize+100) bytes, i.e. nMpdus aggregated packets in an A-MPDU
111 
112  NetDeviceContainer apDevice;
113  apDevice = wifi.Install (phy, mac, wifiApNode);
114 
115  /* Setting mobility model */
116  MobilityHelper mobility;
117  Ptr<ListPositionAllocator> positionAlloc = CreateObject<ListPositionAllocator> ();
118 
119  positionAlloc->Add (Vector (0.0, 0.0, 0.0));
120  positionAlloc->Add (Vector (1.0, 0.0, 0.0));
121  mobility.SetPositionAllocator (positionAlloc);
122 
123  mobility.SetMobilityModel ("ns3::ConstantPositionMobilityModel");
124 
125  mobility.Install (wifiApNode);
126  mobility.Install (wifiStaNode);
127 
128  /* Internet stack*/
130  stack.Install (wifiApNode);
131  stack.Install (wifiStaNode);
132 
134 
135  address.SetBase ("192.168.1.0", "255.255.255.0");
136  Ipv4InterfaceContainer StaInterface;
137  StaInterface = address.Assign (staDevice);
138  Ipv4InterfaceContainer ApInterface;
139  ApInterface = address.Assign (apDevice);
140 
141  /* Setting applications */
142  UdpServerHelper myServer (9);
143  ApplicationContainer serverApp = myServer.Install (wifiStaNode.Get (0));
144  serverApp.Start (Seconds (0.0));
145  serverApp.Stop (Seconds (simulationTime+1));
146 
147  UdpClientHelper myClient (StaInterface.GetAddress (0), 9);
148  myClient.SetAttribute ("MaxPackets", UintegerValue (4294967295u));
149  myClient.SetAttribute ("Interval", TimeValue (Time ("0.00002"))); //packets/s
150  myClient.SetAttribute ("PacketSize", UintegerValue (payloadSize));
151 
152  ApplicationContainer clientApp = myClient.Install (wifiApNode.Get (0));
153  clientApp.Start (Seconds (1.0));
154  clientApp.Stop (Seconds (simulationTime+1));
155 
156  Simulator::Stop (Seconds (simulationTime+1));
157 
158  Simulator::Run ();
160 
161  uint32_t totalPacketsThrough = DynamicCast<UdpServer>(serverApp.Get (0))->GetReceived ();
162  double throughput = totalPacketsThrough*payloadSize*8/(simulationTime*1000000.0);
163  std::cout << "Throughput: " << throughput << " Mbit/s" << '\n';
164 
165  return 0;
166 }
holds a vector of ns3::Application pointers.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:102
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
create HT-enabled MAC layers for a ns3::WifiNetDevice.
AttributeValue implementation for Boolean.
Definition: boolean.h:34
holds a vector of std::pair of Ptr and interface index.
Ptr< YansWifiChannel > Create(void) const
void SetRemoteStationManager(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())
Definition: wifi-helper.cc:73
Hold variables of type string.
Definition: string.h:41
Make it easy to create and manage PHY objects for the yans model.
static YansWifiChannelHelper Default(void)
Create a channel helper in a default working state.
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())
Set the underlying type of the MAC and its attributes.
static void Run(void)
Run the simulation.
Definition: simulator.cc:200
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:201
void SetPcapDataLinkType(enum SupportedPcapDataLinkTypes dlt)
Set the data link type of PCAP traces to be used.
aggregate IP/TCP/UDP functionality to existing Nodes.
static YansWifiPhyHelper Default(void)
Create a phy helper in a default working state.
helps to create WifiNetDevice objects
Definition: wifi-helper.h:92
Best Effort.
Definition: qos-utils.h:38
Include Radiotap link layer information.
virtual NetDeviceContainer Install(const WifiPhyHelper &phy, const WifiMacHelper &mac, NodeContainer c) const
Definition: wifi-helper.cc:102
static HtWifiMacHelper Default(void)
Create a mac helper in a default working state.
void SetChannel(Ptr< YansWifiChannel > channel)
void Install(Ptr< Node > node) const
"Layout" a single node according to the current position allocator type.
void SetBlockAckThresholdForAc(enum AcIndex ac, uint8_t threshold)
This method sets value of block ack threshold for a specific access class.
Create a client application which sends UDP packets carrying a 32bit sequence number and a 64 bit tim...
AttributeValue implementation for Time.
Definition: nstime.h:928
Hold an unsigned integer type.
Definition: uinteger.h:44
void SetMpduAggregatorForAc(enum AcIndex ac, 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())
Set the class, type and attributes for the Mpdu aggregator.
holds a vector of ns3::NetDevice pointers
virtual void SetStandard(enum WifiPhyStandard standard)
Definition: wifi-helper.cc:96
Create a server application which waits for input UDP packets and uses the information carried into t...
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:201
static void Destroy(void)
Execute the events scheduled with ScheduleDestroy().
Definition: simulator.cc:164
void SetAttribute(std::string name, const AttributeValue &value)
Record an attribute to be set in each Application after it is is created.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
keep track of a set of node pointers.
Ptr< Application > Get(uint32_t i) const
Get the Ptr stored in this container at a given index.
void SetMobilityModel(std::string type, 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())
void Install(std::string nodeName) const
Aggregate implementations of the ns3::Ipv4, ns3::Ipv6, ns3::Udp, and ns3::Tcp classes onto the provid...
manage and create wifi channel objects for the yans model.
tuple stack
Definition: first.py:34
The IEEE 802.11 SSID Information Element.
Definition: ssid.h:37
Helper class used to assign positions and mobility models to nodes.
void Stop(Time stop)
Arrange for all of the Applications in this container to Stop() at the Time given as a parameter...
Ipv4InterfaceContainer Assign(const NetDeviceContainer &c)
Assign IP addresses to the net devices specified in the container based on the current network prefix...
void AddValue(const std::string &name, const std::string &help, T &value)
Add a program argument, assigning to POD.
Definition: command-line.h:491
static void Stop(void)
Tell the Simulator the calling event should be the last one executed.
Definition: simulator.cc:208
Ptr< Node > Get(uint32_t i) const
Get the Ptr stored in this container at a given index.
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:866
AttributeValue implementation for Ssid.
Definition: ssid.h:93
void SetDefault(std::string name, const AttributeValue &value)
Definition: config.cc:683
void Add(Vector v)
Add a position to the list of positions.
void Parse(int argc, char *argv[])
Parse the program arguments.
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
Time MicroSeconds(uint64_t value)
Construct a Time in the indicated unit.
Definition: nstime.h:882
void Create(uint32_t n)
Create n nodes and append pointers to them to the end of this NodeContainer.
tuple address
Definition: first.py:37
void SetPositionAllocator(Ptr< PositionAllocator > allocator)
Set the position allocator which will be used to allocate the initial position of every node initiali...
void SetBase(Ipv4Address network, Ipv4Mask mask, Ipv4Address base="0.0.0.1")
Set the base network number, network mask and base address.
Ipv4Address GetAddress(uint32_t i, uint32_t j=0) const
static WifiHelper Default(void)
Definition: wifi-helper.cc:65