A Discrete-Event Network Simulator
API
80211n-mimo.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  * Authors: S├ębastien Deronne <sebastien.deronne@gmail.com>
17  */
18 
19 // This example is used to validate 802.11n MIMO.
20 //
21 // It outputs plots of the throughput versus the distance
22 // for every HT MCS value and from 1 to 4 MIMO streams.
23 //
24 // The simulation assumes a single station in an infrastructure network:
25 //
26 // STA AP
27 // * *
28 // | |
29 // n1 n2
30 //
31 // The user can choose whether UDP or TCP should be used and can configure
32 // some 802.11n parameters (frequency, channel width and guard interval).
33 
34 #include "ns3/core-module.h"
35 #include "ns3/applications-module.h"
36 #include "ns3/wifi-module.h"
37 #include "ns3/mobility-module.h"
38 #include "ns3/internet-module.h"
39 #include "ns3/gnuplot.h"
40 
41 using namespace ns3;
42 
43 int main (int argc, char *argv[])
44 {
45  std::ofstream file ("80211n-mimo-throughput.plt");
46 
47  std::vector <std::string> modes;
48  modes.push_back ("HtMcs0");
49  modes.push_back ("HtMcs1");
50  modes.push_back ("HtMcs2");
51  modes.push_back ("HtMcs3");
52  modes.push_back ("HtMcs4");
53  modes.push_back ("HtMcs5");
54  modes.push_back ("HtMcs6");
55  modes.push_back ("HtMcs7");
56  modes.push_back ("HtMcs8");
57  modes.push_back ("HtMcs9");
58  modes.push_back ("HtMcs10");
59  modes.push_back ("HtMcs11");
60  modes.push_back ("HtMcs12");
61  modes.push_back ("HtMcs13");
62  modes.push_back ("HtMcs14");
63  modes.push_back ("HtMcs15");
64  modes.push_back ("HtMcs16");
65  modes.push_back ("HtMcs17");
66  modes.push_back ("HtMcs18");
67  modes.push_back ("HtMcs19");
68  modes.push_back ("HtMcs20");
69  modes.push_back ("HtMcs21");
70  modes.push_back ("HtMcs22");
71  modes.push_back ("HtMcs23");
72  modes.push_back ("HtMcs24");
73  modes.push_back ("HtMcs25");
74  modes.push_back ("HtMcs26");
75  modes.push_back ("HtMcs27");
76  modes.push_back ("HtMcs28");
77  modes.push_back ("HtMcs29");
78  modes.push_back ("HtMcs30");
79  modes.push_back ("HtMcs31");
80 
81  bool udp = true;
82  double simulationTime = 5; //seconds
83  double frequency = 5.0; //whether 2.4 or 5.0 GHz
84  double step = 5; //meters
85  bool shortGuardInterval = false;
86  bool channelBonding = false;
87 
89  cmd.AddValue ("step", "Granularity of the results to be plotted in meters", step);
90  cmd.AddValue ("channelBonding", "Enable/disable channel bonding (channel width = 20 MHz if false, channel width = 40 MHz if true)", channelBonding);
91  cmd.AddValue ("shortGuardInterval", "Enable/disable short guard interval", shortGuardInterval);
92  cmd.AddValue ("frequency", "Whether working in the 2.4 or 5.0 GHz band (other values gets rejected)", frequency);
93  cmd.AddValue ("udp", "UDP if set to 1, TCP otherwise", udp);
94  cmd.Parse (argc,argv);
95 
96  Gnuplot plot = Gnuplot ("80211n-mimo-throughput.eps");
97 
98  for (uint32_t i = 0; i < modes.size (); i++) //MCS
99  {
100  std::cout << modes[i] << std::endl;
101  Gnuplot2dDataset dataset (modes[i]);
102  for (int d = 0; d <= 100; ) //distance
103  {
104  std::cout << "Distance = " << d << "m: " << std::endl;
105  uint32_t payloadSize; //1500 byte IP packet
106  if (udp)
107  {
108  payloadSize = 1472; //bytes
109  }
110  else
111  {
112  payloadSize = 1448; //bytes
113  Config::SetDefault ("ns3::TcpSocket::SegmentSize", UintegerValue (payloadSize));
114  }
115 
116  uint8_t nStreams = 1 + (i / 8); //number of MIMO streams
117 
118  NodeContainer wifiStaNode;
119  wifiStaNode.Create (1);
121  wifiApNode.Create (1);
122 
125  phy.SetChannel (channel.Create ());
126 
127  // Set guard interval
128  phy.Set ("ShortGuardEnabled", BooleanValue (shortGuardInterval));
129  // Set MIMO capabilities
130  phy.Set ("Antennas", UintegerValue (nStreams));
131  phy.Set ("MaxSupportedTxSpatialStreams", UintegerValue (nStreams));
132  phy.Set ("MaxSupportedRxSpatialStreams", UintegerValue (nStreams));
133 
136  if (frequency == 5.0)
137  {
139  }
140  else if (frequency == 2.4)
141  {
143  Config::SetDefault ("ns3::LogDistancePropagationLossModel::ReferenceLoss", DoubleValue (40.046));
144  }
145  else
146  {
147  std::cout << "Wrong frequency value!" << std::endl;
148  return 0;
149  }
150 
151  wifi.SetRemoteStationManager ("ns3::ConstantRateWifiManager","DataMode", StringValue (modes[i]),
152  "ControlMode", StringValue (modes[i]));
153 
154  Ssid ssid = Ssid ("ns3-80211n");
155 
156  mac.SetType ("ns3::StaWifiMac",
157  "Ssid", SsidValue (ssid));
158 
159  NetDeviceContainer staDevice;
160  staDevice = wifi.Install (phy, mac, wifiStaNode);
161 
162  mac.SetType ("ns3::ApWifiMac",
163  "Ssid", SsidValue (ssid));
164 
165  NetDeviceContainer apDevice;
166  apDevice = wifi.Install (phy, mac, wifiApNode);
167 
168  // Set channel width
169  if (channelBonding)
170  {
171  Config::Set ("/NodeList/*/DeviceList/*/$ns3::WifiNetDevice/Phy/ChannelWidth", UintegerValue (40));
172  }
173 
174  // mobility.
176  Ptr<ListPositionAllocator> positionAlloc = CreateObject<ListPositionAllocator> ();
177 
178  positionAlloc->Add (Vector (0.0, 0.0, 0.0));
179  positionAlloc->Add (Vector (d, 0.0, 0.0));
180  mobility.SetPositionAllocator (positionAlloc);
181 
182  mobility.SetMobilityModel ("ns3::ConstantPositionMobilityModel");
183 
184  mobility.Install (wifiApNode);
185  mobility.Install (wifiStaNode);
186 
187  /* Internet stack*/
189  stack.Install (wifiApNode);
190  stack.Install (wifiStaNode);
191 
193  address.SetBase ("192.168.1.0", "255.255.255.0");
194  Ipv4InterfaceContainer staNodeInterface;
195  Ipv4InterfaceContainer apNodeInterface;
196 
197  staNodeInterface = address.Assign (staDevice);
198  apNodeInterface = address.Assign (apDevice);
199 
200  /* Setting applications */
201  ApplicationContainer serverApp;
202  if (udp)
203  {
204  //UDP flow
205  uint16_t port = 9;
206  UdpServerHelper server (port);
207  serverApp = server.Install (wifiStaNode.Get (0));
208  serverApp.Start (Seconds (0.0));
209  serverApp.Stop (Seconds (simulationTime + 1));
210 
211  UdpClientHelper client (staNodeInterface.GetAddress (0), port);
212  client.SetAttribute ("MaxPackets", UintegerValue (4294967295u));
213  client.SetAttribute ("Interval", TimeValue (Time ("0.00001"))); //packets/s
214  client.SetAttribute ("PacketSize", UintegerValue (payloadSize));
215  ApplicationContainer clientApp = client.Install (wifiApNode.Get (0));
216  clientApp.Start (Seconds (1.0));
217  clientApp.Stop (Seconds (simulationTime + 1));
218  }
219  else
220  {
221  //TCP flow
222  uint16_t port = 50000;
223  Address localAddress (InetSocketAddress (Ipv4Address::GetAny (), port));
224  PacketSinkHelper packetSinkHelper ("ns3::TcpSocketFactory", localAddress);
225  serverApp = packetSinkHelper.Install (wifiStaNode.Get (0));
226  serverApp.Start (Seconds (0.0));
227  serverApp.Stop (Seconds (simulationTime + 1));
228 
229  OnOffHelper onoff ("ns3::TcpSocketFactory",Ipv4Address::GetAny ());
230  onoff.SetAttribute ("OnTime", StringValue ("ns3::ConstantRandomVariable[Constant=1]"));
231  onoff.SetAttribute ("OffTime", StringValue ("ns3::ConstantRandomVariable[Constant=0]"));
232  onoff.SetAttribute ("PacketSize", UintegerValue (payloadSize));
233  onoff.SetAttribute ("DataRate", DataRateValue (1000000000)); //bit/s
234  AddressValue remoteAddress (InetSocketAddress (staNodeInterface.GetAddress (0), port));
235  onoff.SetAttribute ("Remote", remoteAddress);
236  ApplicationContainer clientApp = onoff.Install (wifiApNode.Get (0));
237  clientApp.Start (Seconds (1.0));
238  clientApp.Stop (Seconds (simulationTime + 1));
239  }
240 
242 
243  Simulator::Stop (Seconds (simulationTime + 1));
244  Simulator::Run ();
246 
247  double throughput = 0;
248  if (udp)
249  {
250  //UDP
251  uint64_t totalPacketsThrough = DynamicCast<UdpServer> (serverApp.Get (0))->GetReceived ();
252  throughput = totalPacketsThrough * payloadSize * 8 / (simulationTime * 1000000.0); //Mbit/s
253  }
254  else
255  {
256  //TCP
257  uint64_t totalPacketsThrough = DynamicCast<PacketSink> (serverApp.Get (0))->GetTotalRx ();
258  throughput = totalPacketsThrough * 8 / (simulationTime * 1000000.0); //Mbit/s
259  }
260  dataset.Add (d, throughput);
261  std::cout << throughput << " Mbit/s" << std::endl;
262  d += step;
263  }
264  plot.AddDataset (dataset);
265  }
266 
267  plot.SetTerminal ("postscript eps color enh \"Times-BoldItalic\"");
268  plot.SetLegend ("Distance (Meters)", "Throughput (Mbit/s)");
269  plot.SetExtra ("set xrange [0:100]\n\
270 set yrange [0:600]\n\
271 set ytics 0,50,600\n\
272 set style line 1 dashtype 1 linewidth 5\n\
273 set style line 2 dashtype 1 linewidth 5\n\
274 set style line 3 dashtype 1 linewidth 5\n\
275 set style line 4 dashtype 1 linewidth 5\n\
276 set style line 5 dashtype 1 linewidth 5\n\
277 set style line 6 dashtype 1 linewidth 5\n\
278 set style line 7 dashtype 1 linewidth 5\n\
279 set style line 8 dashtype 1 linewidth 5\n\
280 set style line 9 dashtype 2 linewidth 5\n\
281 set style line 10 dashtype 2 linewidth 5\n\
282 set style line 11 dashtype 2 linewidth 5\n\
283 set style line 12 dashtype 2 linewidth 5\n\
284 set style line 13 dashtype 2 linewidth 5\n\
285 set style line 14 dashtype 2 linewidth 5\n\
286 set style line 15 dashtype 2 linewidth 5\n\
287 set style line 16 dashtype 2 linewidth 5\n\
288 set style line 17 dashtype 3 linewidth 5\n\
289 set style line 18 dashtype 3 linewidth 5\n\
290 set style line 19 dashtype 3 linewidth 5\n\
291 set style line 20 dashtype 3 linewidth 5\n\
292 set style line 21 dashtype 3 linewidth 5\n\
293 set style line 22 dashtype 3 linewidth 5\n\
294 set style line 23 dashtype 3 linewidth 5\n\
295 set style line 24 dashtype 3 linewidth 5\n\
296 set style line 25 dashtype 4 linewidth 5\n\
297 set style line 26 dashtype 4 linewidth 5\n\
298 set style line 27 dashtype 4 linewidth 5\n\
299 set style line 28 dashtype 4 linewidth 5\n\
300 set style line 29 dashtype 4 linewidth 5\n\
301 set style line 30 dashtype 4 linewidth 5\n\
302 set style line 31 dashtype 4 linewidth 5\n\
303 set style line 32 dashtype 4 linewidth 5\n\
304 set style increment user" );
305  plot.GenerateOutput (file);
306  file.close ();
307 
308  return 0;
309 }
310 
tuple channel
Definition: third.py:85
void Set(std::string name, const AttributeValue &v)
Definition: wifi-helper.cc:132
holds a vector of ns3::Application pointers.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:102
an Inet address class
static Ipv4Address GetAny(void)
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
AttributeValue implementation for Boolean.
Definition: boolean.h:36
HT PHY for the 5 GHz band (clause 20)
Class to represent a 2D points plot.
Definition: gnuplot.h:117
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:719
static void PopulateRoutingTables(void)
Build a routing database and initialize the routing tables of the nodes in the simulation.
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.
void Set(std::string path, const AttributeValue &value)
Definition: config.cc:777
static void Run(void)
Run the simulation.
Definition: simulator.cc:226
aggregate IP/TCP/UDP functionality to existing Nodes.
void AddDataset(const GnuplotDataset &dataset)
Definition: gnuplot.cc:756
A helper to make it easier to instantiate an ns3::PacketSinkApplication on a set of nodes...
HT PHY for the 2.4 GHz band (clause 20)
static YansWifiPhyHelper Default(void)
Create a phy helper in a default working state.
helps to create WifiNetDevice objects
Definition: wifi-helper.h:213
A helper to make it easier to instantiate an ns3::OnOffApplication on a set of nodes.
Definition: on-off-helper.h:42
tuple cmd
Definition: second.py:35
uint16_t port
Definition: dsdv-manet.cc:44
a polymophic address class
Definition: address.h:90
void SetChannel(Ptr< YansWifiChannel > channel)
void Install(Ptr< Node > node) const
"Layout" a single node according to the current position allocator type.
tuple mobility
Definition: third.py:101
tuple phy
Definition: third.py:86
a simple class to generate gnuplot-ready plotting commands from a set of datasets.
Definition: gnuplot.h:371
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:1055
Hold an unsigned integer type.
Definition: uinteger.h:44
holds a vector of ns3::NetDevice pointers
virtual void SetStandard(enum WifiPhyStandard standard)
Definition: wifi-helper.cc:742
Create a server application which waits for input UDP packets and uses the information carried into t...
virtual NetDeviceContainer Install(const WifiPhyHelper &phy, const WifiMacHelper &mac, NodeContainer::Iterator first, NodeContainer::Iterator last) const
Definition: wifi-helper.cc:748
void GenerateOutput(std::ostream &os)
Writes gnuplot commands and data values to a single output stream.
Definition: gnuplot.cc:762
tuple mac
Definition: third.py:92
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:205
void SetLegend(const std::string &xLegend, const std::string &yLegend)
Definition: gnuplot.cc:736
static void Destroy(void)
Execute the events scheduled with ScheduleDestroy().
Definition: simulator.cc:190
tuple wifiApNode
Definition: third.py:83
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...
tuple ssid
Definition: third.py:93
manage and create wifi channel objects for the yans model.
create MAC layers for a ns3::WifiNetDevice.
void SetExtra(const std::string &extra)
Definition: gnuplot.cc:743
tuple stack
Definition: first.py:34
The IEEE 802.11 SSID Information Element.
Definition: ssid.h:35
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())
Helper class used to assign positions and mobility models to nodes.
AttributeValue implementation for Address.
Definition: address.h:278
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...
AttributeValue implementation for DataRate.
Definition: data-rate.h:242
void AddValue(const std::string &name, const std::string &help, T &value)
Add a program argument, assigning to POD.
Definition: command-line.h:498
static void Stop(void)
Tell the Simulator the calling event should be the last one executed.
Definition: simulator.cc:234
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:993
AttributeValue implementation for Ssid.
Definition: ssid.h:117
void SetDefault(std::string name, const AttributeValue &value)
Definition: config.cc:782
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.
tuple wifi
Definition: third.py:89
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 SetTerminal(const std::string &terminal)
Definition: gnuplot.cc:724
This class can be used to hold variables of floating point type such as 'double' or 'float'...
Definition: double.h:41
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