A Discrete-Event Network Simulator
API
ht-wifi-network.cc
Go to the documentation of this file.
1 /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2009 MIRKO BANCHI
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  * Authors: Mirko Banchi <mk.banchi@gmail.com>
19  * Sebastien Deronne <sebastien.deronne@gmail.com>
20  */
21 
22 #include "ns3/command-line.h"
23 #include "ns3/config.h"
24 #include "ns3/uinteger.h"
25 #include "ns3/boolean.h"
26 #include "ns3/double.h"
27 #include "ns3/string.h"
28 #include "ns3/log.h"
29 #include "ns3/yans-wifi-helper.h"
30 #include "ns3/ssid.h"
31 #include "ns3/mobility-helper.h"
32 #include "ns3/internet-stack-helper.h"
33 #include "ns3/ipv4-address-helper.h"
34 #include "ns3/udp-client-server-helper.h"
35 #include "ns3/packet-sink-helper.h"
36 #include "ns3/on-off-helper.h"
37 #include "ns3/ipv4-global-routing-helper.h"
38 #include "ns3/packet-sink.h"
39 #include "ns3/yans-wifi-channel.h"
40 
41 // This is a simple example in order to show how to configure an IEEE 802.11n Wi-Fi network.
42 //
43 // It outputs the UDP or TCP goodput for every HT MCS value, which depends on the MCS value (0 to 7), the
44 // channel width (20 or 40 MHz) and the guard interval (long or short). The PHY bitrate is constant over all
45 // the simulation run. The user can also specify the distance between the access point and the station: the
46 // larger the distance the smaller the goodput.
47 //
48 // The simulation assumes a single station in an infrastructure network:
49 //
50 // STA AP
51 // * *
52 // | |
53 // n1 n2
54 //
55 //Packets in this simulation aren't marked with a QosTag so they are considered
56 //belonging to BestEffort Access Class (AC_BE).
57 
58 using namespace ns3;
59 
60 NS_LOG_COMPONENT_DEFINE ("ht-wifi-network");
61 
62 int main (int argc, char *argv[])
63 {
64  bool udp = true;
65  bool useRts = false;
66  double simulationTime = 10; //seconds
67  double distance = 1.0; //meters
68  double frequency = 5.0; //whether 2.4 or 5.0 GHz
69  int mcs = -1; // -1 indicates an unset value
70  double minExpectedThroughput = 0;
71  double maxExpectedThroughput = 0;
72 
74  cmd.AddValue ("frequency", "Whether working in the 2.4 or 5.0 GHz band (other values gets rejected)", frequency);
75  cmd.AddValue ("distance", "Distance in meters between the station and the access point", distance);
76  cmd.AddValue ("simulationTime", "Simulation time in seconds", simulationTime);
77  cmd.AddValue ("udp", "UDP if set to 1, TCP otherwise", udp);
78  cmd.AddValue ("useRts", "Enable/disable RTS/CTS", useRts);
79  cmd.AddValue ("mcs", "if set, limit testing to a specific MCS (0-7)", mcs);
80  cmd.AddValue ("minExpectedThroughput", "if set, simulation fails if the lowest throughput is below this value", minExpectedThroughput);
81  cmd.AddValue ("maxExpectedThroughput", "if set, simulation fails if the highest throughput is above this value", maxExpectedThroughput);
82  cmd.Parse (argc,argv);
83 
84  if (useRts)
85  {
86  Config::SetDefault ("ns3::WifiRemoteStationManager::RtsCtsThreshold", StringValue ("0"));
87  }
88 
89  double prevThroughput [8];
90  for (uint32_t l = 0; l < 8; l++)
91  {
92  prevThroughput[l] = 0;
93  }
94  std::cout << "MCS value" << "\t\t" << "Channel width" << "\t\t" << "short GI" << "\t\t" << "Throughput" << '\n';
95  int minMcs = 0;
96  int maxMcs = 7;
97  if (mcs >= 0 && mcs <= 7)
98  {
99  minMcs = mcs;
100  maxMcs = mcs;
101  }
102  for (int mcs = minMcs; mcs <= maxMcs; mcs++)
103  {
104  uint8_t index = 0;
105  double previous = 0;
106  for (int channelWidth = 20; channelWidth <= 40; )
107  {
108  for (int sgi = 0; sgi < 2; sgi++)
109  {
110  uint32_t payloadSize; //1500 byte IP packet
111  if (udp)
112  {
113  payloadSize = 1472; //bytes
114  }
115  else
116  {
117  payloadSize = 1448; //bytes
118  Config::SetDefault ("ns3::TcpSocket::SegmentSize", UintegerValue (payloadSize));
119  }
120 
121  NodeContainer wifiStaNode;
122  wifiStaNode.Create (1);
124  wifiApNode.Create (1);
125 
128  phy.SetChannel (channel.Create ());
129 
130  // Set guard interval
131  phy.Set ("ShortGuardEnabled", BooleanValue (sgi));
132 
135  if (frequency == 5.0)
136  {
137  wifi.SetStandard (WIFI_PHY_STANDARD_80211n_5GHZ);
138  }
139  else if (frequency == 2.4)
140  {
142  Config::SetDefault ("ns3::LogDistancePropagationLossModel::ReferenceLoss", DoubleValue (40.046));
143  }
144  else
145  {
146  std::cout << "Wrong frequency value!" << std::endl;
147  return 0;
148  }
149 
150  std::ostringstream oss;
151  oss << "HtMcs" << mcs;
152  wifi.SetRemoteStationManager ("ns3::ConstantRateWifiManager","DataMode", StringValue (oss.str ()),
153  "ControlMode", StringValue (oss.str ()));
154 
155  Ssid ssid = Ssid ("ns3-80211n");
156 
157  mac.SetType ("ns3::StaWifiMac",
158  "Ssid", SsidValue (ssid));
159 
160  NetDeviceContainer staDevice;
161  staDevice = wifi.Install (phy, mac, wifiStaNode);
162 
163  mac.SetType ("ns3::ApWifiMac",
164  "EnableBeaconJitter", BooleanValue (false),
165  "Ssid", SsidValue (ssid));
166 
167  NetDeviceContainer apDevice;
168  apDevice = wifi.Install (phy, mac, wifiApNode);
169 
170  // Set channel width
171  Config::Set ("/NodeList/*/DeviceList/*/$ns3::WifiNetDevice/Phy/ChannelWidth", UintegerValue (channelWidth));
172 
173  // mobility.
175  Ptr<ListPositionAllocator> positionAlloc = CreateObject<ListPositionAllocator> ();
176 
177  positionAlloc->Add (Vector (0.0, 0.0, 0.0));
178  positionAlloc->Add (Vector (distance, 0.0, 0.0));
179  mobility.SetPositionAllocator (positionAlloc);
180 
181  mobility.SetMobilityModel ("ns3::ConstantPositionMobilityModel");
182 
183  mobility.Install (wifiApNode);
184  mobility.Install (wifiStaNode);
185 
186  /* Internet stack*/
188  stack.Install (wifiApNode);
189  stack.Install (wifiStaNode);
190 
192  address.SetBase ("192.168.1.0", "255.255.255.0");
193  Ipv4InterfaceContainer staNodeInterface;
194  Ipv4InterfaceContainer apNodeInterface;
195 
196  staNodeInterface = address.Assign (staDevice);
197  apNodeInterface = address.Assign (apDevice);
198 
199  /* Setting applications */
200  ApplicationContainer serverApp;
201  if (udp)
202  {
203  //UDP flow
204  uint16_t port = 9;
205  UdpServerHelper server (port);
206  serverApp = server.Install (wifiStaNode.Get (0));
207  serverApp.Start (Seconds (0.0));
208  serverApp.Stop (Seconds (simulationTime + 1));
209 
210  UdpClientHelper client (staNodeInterface.GetAddress (0), port);
211  client.SetAttribute ("MaxPackets", UintegerValue (4294967295u));
212  client.SetAttribute ("Interval", TimeValue (Time ("0.00001"))); //packets/s
213  client.SetAttribute ("PacketSize", UintegerValue (payloadSize));
214  ApplicationContainer clientApp = client.Install (wifiApNode.Get (0));
215  clientApp.Start (Seconds (1.0));
216  clientApp.Stop (Seconds (simulationTime + 1));
217  }
218  else
219  {
220  //TCP flow
221  uint16_t port = 50000;
222  Address localAddress (InetSocketAddress (Ipv4Address::GetAny (), port));
223  PacketSinkHelper packetSinkHelper ("ns3::TcpSocketFactory", localAddress);
224  serverApp = packetSinkHelper.Install (wifiStaNode.Get (0));
225  serverApp.Start (Seconds (0.0));
226  serverApp.Stop (Seconds (simulationTime + 1));
227 
228  OnOffHelper onoff ("ns3::TcpSocketFactory", Ipv4Address::GetAny ());
229  onoff.SetAttribute ("OnTime", StringValue ("ns3::ConstantRandomVariable[Constant=1]"));
230  onoff.SetAttribute ("OffTime", StringValue ("ns3::ConstantRandomVariable[Constant=0]"));
231  onoff.SetAttribute ("PacketSize", UintegerValue (payloadSize));
232  onoff.SetAttribute ("DataRate", DataRateValue (1000000000)); //bit/s
233  AddressValue remoteAddress (InetSocketAddress (staNodeInterface.GetAddress (0), port));
234  onoff.SetAttribute ("Remote", remoteAddress);
235  ApplicationContainer clientApp = onoff.Install (wifiApNode.Get (0));
236  clientApp.Start (Seconds (1.0));
237  clientApp.Stop (Seconds (simulationTime + 1));
238  }
239 
241 
242  Simulator::Stop (Seconds (simulationTime + 1));
243  Simulator::Run ();
244 
245  uint64_t rxBytes = 0;
246  if (udp)
247  {
248  rxBytes = payloadSize * DynamicCast<UdpServer> (serverApp.Get (0))->GetReceived ();
249  }
250  else
251  {
252  rxBytes = DynamicCast<PacketSink> (serverApp.Get (0))->GetTotalRx ();
253  }
254  double throughput = (rxBytes * 8) / (simulationTime * 1000000.0); //Mbit/s
255 
257 
258  std::cout << mcs << "\t\t\t" << channelWidth << " MHz\t\t\t" << sgi << "\t\t\t" << throughput << " Mbit/s" << std::endl;
259 
260  //test first element
261  if (mcs == 0 && channelWidth == 20 && sgi == 0)
262  {
263  if (throughput < minExpectedThroughput)
264  {
265  NS_LOG_ERROR ("Obtained throughput " << throughput << " is not expected!");
266  exit (1);
267  }
268  }
269  //test last element
270  if (mcs == 7 && channelWidth == 40 && sgi == 1)
271  {
272  if (maxExpectedThroughput > 0 && throughput > maxExpectedThroughput)
273  {
274  NS_LOG_ERROR ("Obtained throughput " << throughput << " is not expected!");
275  exit (1);
276  }
277  }
278  //test previous throughput is smaller (for the same mcs)
279  if (throughput > previous)
280  {
281  previous = throughput;
282  }
283  else
284  {
285  NS_LOG_ERROR ("Obtained throughput " << throughput << " is not expected!");
286  exit (1);
287  }
288  //test previous throughput is smaller (for the same channel width and GI)
289  if (throughput > prevThroughput [index])
290  {
291  prevThroughput [index] = throughput;
292  }
293  else
294  {
295  NS_LOG_ERROR ("Obtained throughput " << throughput << " is not expected!");
296  exit (1);
297  }
298  index++;
299 
300  }
301  channelWidth *= 2;
302  }
303  }
304  return 0;
305 }
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)
holds a vector of std::pair of Ptr<Ipv4> and interface index.
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
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
aggregate IP/TCP/UDP functionality to existing Nodes.
A helper to make it easier to instantiate an ns3::PacketSinkApplication on a set of nodes...
cmd
Definition: second.py:35
HT PHY for the 2.4 GHz band (clause 20)
static YansWifiPhyHelper Default(void)
Create a phy helper in a default working state.
STL namespace.
helps to create WifiNetDevice objects
Definition: wifi-helper.h:230
A helper to make it easier to instantiate an ns3::OnOffApplication on a set of nodes.
Definition: on-off-helper.h:42
stack
Definition: first.py:34
uint16_t port
Definition: dsdv-manet.cc:45
a polymophic address class
Definition: address.h:90
channel
Definition: third.py:85
mobility
Definition: third.py:101
phy
Definition: third.py:86
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:1076
Ipv4Address GetAddress(uint32_t i, uint32_t j=0) const
Hold an unsigned integer type.
Definition: uinteger.h:44
ssid
Definition: third.py:93
holds a vector of ns3::NetDevice pointers
mac
Definition: third.py:92
Create a server application which waits for input UDP packets and uses the information carried into t...
wifiApNode
Definition: third.py:83
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:213
static void Destroy(void)
Execute the events scheduled with ScheduleDestroy().
Definition: simulator.cc:190
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.
address
Definition: first.py:37
manage and create wifi channel objects for the yans model.
create MAC layers for a ns3::WifiNetDevice.
The IEEE 802.11 SSID Information Element.
Definition: ssid.h:35
wifi
Definition: third.py:89
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...
AttributeValue implementation for DataRate.
Definition: data-rate.h:242
static void Stop(void)
Tell the Simulator the calling event should be the last one executed.
Definition: simulator.cc:234
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1014
AttributeValue implementation for Ssid.
Definition: ssid.h:110
void SetDefault(std::string name, const AttributeValue &value)
Definition: config.cc:782
void Add(Vector v)
Add a position to the list of positions.
Ptr< Node > Get(uint32_t i) const
Get the Ptr<Node> stored in this container at a given index.
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
#define NS_LOG_ERROR(msg)
Use NS_LOG to output a message of level LOG_ERROR.
Definition: log.h:254
void Create(uint32_t n)
Create n nodes and append pointers to them to the end of this NodeContainer.
This class can be used to hold variables of floating point type such as &#39;double&#39; or &#39;float&#39;...
Definition: double.h:41
Ptr< Application > Get(uint32_t i) const
Get the Ptr<Application> stored in this container at a given index.