A Discrete-Event Network Simulator
API
wifi-ac-mapping-test-suite.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2016 Universita' degli Studi di Napoli Federico II
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: Stefano Avallone <stavallo@unina.it>
19  */
20 
21 #include "ns3/string.h"
22 #include "ns3/test.h"
23 #include "ns3/pointer.h"
24 #include "ns3/ssid.h"
25 #include "ns3/packet-sink.h"
26 #include "ns3/wifi-net-device.h"
27 #include "ns3/wifi-mac.h"
28 #include "ns3/wifi-mac-queue.h"
29 #include "ns3/qos-txop.h"
30 #include "ns3/yans-wifi-helper.h"
31 #include "ns3/mobility-helper.h"
32 #include "ns3/internet-stack-helper.h"
33 #include "ns3/ipv4-address-helper.h"
34 #include "ns3/packet-sink-helper.h"
35 #include "ns3/on-off-helper.h"
36 #include "ns3/traffic-control-helper.h"
37 #include "ns3/traffic-control-layer.h"
38 #include "ns3/llc-snap-header.h"
39 
40 using namespace ns3;
41 
42 NS_LOG_COMPONENT_DEFINE ("WifiAcMappingTest");
43 
51 {
52 public:
59  WifiAcMappingTest (uint8_t tos, uint8_t expectedQueue);
60  virtual void DoRun (void);
61 
62 private:
71  static void PacketEnqueuedInQueueDisc (uint8_t tos, uint16_t* count, Ptr<const QueueDiscItem> item);
80  static void PacketEnqueuedInWifiMacQueue (uint8_t tos, uint16_t* count, Ptr<const WifiMacQueueItem> item);
81  uint8_t m_tos;
82  uint16_t m_expectedQueue;
83  uint16_t m_QueueDiscCount[4];
84  uint16_t m_WifiMacQueueCount[4];
85 };
86 
87 WifiAcMappingTest::WifiAcMappingTest (uint8_t tos, uint8_t expectedQueue)
88  : TestCase ("User priority to Access Category mapping test. Checks that packets are "
89  "enqueued in the correct child queue disc of the mq root queue disc and "
90  "in the correct wifi MAC queue"),
91  m_tos (tos),
92  m_expectedQueue (expectedQueue)
93 {
94  for (uint8_t i = 0; i < 4; i++)
95  {
96  m_QueueDiscCount[i] = 0;
97  m_WifiMacQueueCount[i] = 0;
98  }
99 }
100 
101 void
103 {
104  uint8_t val;
105  if (item->GetUint8Value (QueueItem::IP_DSFIELD, val) && val == tos)
106  {
107  (*count)++;
108  }
109 }
110 
111 void
113 {
114  LlcSnapHeader llc;
115  Ptr<Packet> packet = item->GetPacket ()->Copy ();
116  packet->RemoveHeader (llc);
117 
118  if (llc.GetType () == Ipv4L3Protocol::PROT_NUMBER)
119  {
120  Ipv4Header iph;
121  packet->PeekHeader (iph);
122  if (iph.GetTos () == tos)
123  {
124  (*count)++;
125  }
126  }
127 }
128 
129 void
131 {
133  WifiMacHelper wifiMac;
134  YansWifiPhyHelper wifiPhy;
135  YansWifiChannelHelper wifiChannel = YansWifiChannelHelper::Default ();
136  wifiPhy.SetChannel (wifiChannel.Create ());
137 
138  Ssid ssid = Ssid ("wifi-ac-mapping");
139 
140  // Setup the AP, which will be the source of traffic for this test
141  NodeContainer ap;
142  ap.Create (1);
143  wifiMac.SetType ("ns3::ApWifiMac",
144  "QosSupported", BooleanValue (true),
145  "Ssid", SsidValue (ssid));
146 
147  NetDeviceContainer apDev = wifi.Install (wifiPhy, wifiMac, ap);
148 
149  // Setup one STA, which will be the sink for traffic in this test.
150  NodeContainer sta;
151  sta.Create (1);
152  wifiMac.SetType ("ns3::StaWifiMac",
153  "QosSupported", BooleanValue (true),
154  "Ssid", SsidValue (ssid));
155  NetDeviceContainer staDev = wifi.Install (wifiPhy, wifiMac, sta);
156 
157  // Our devices will have fixed positions
159  mobility.SetMobilityModel ("ns3::ConstantPositionMobilityModel");
160  mobility.SetPositionAllocator ("ns3::GridPositionAllocator",
161  "MinX", DoubleValue (0.0),
162  "MinY", DoubleValue (0.0),
163  "DeltaX", DoubleValue (5.0),
164  "DeltaY", DoubleValue (10.0),
165  "GridWidth", UintegerValue (2),
166  "LayoutType", StringValue ("RowFirst"));
167  mobility.Install (sta);
168  mobility.Install (ap);
169 
170  // Now we install internet stacks on our devices
172  stack.Install (ap);
173  stack.Install (sta);
174 
176  uint16_t handle = tch.SetRootQueueDisc ("ns3::MqQueueDisc");
177  TrafficControlHelper::ClassIdList cls = tch.AddQueueDiscClasses (handle, 4, "ns3::QueueDiscClass");
178  tch.AddChildQueueDiscs (handle, cls, "ns3::FqCoDelQueueDisc");
179  tch.Install (apDev);
180  tch.Install (staDev);
181 
183  address.SetBase ("192.168.0.0", "255.255.255.0");
184  Ipv4InterfaceContainer staNodeInterface, apNodeInterface;
185  staNodeInterface = address.Assign (staDev);
186  apNodeInterface = address.Assign (apDev);
187 
188  uint16_t udpPort = 50000;
189 
190  PacketSinkHelper packetSink ("ns3::UdpSocketFactory",
191  InetSocketAddress (Ipv4Address::GetAny (), udpPort));
192  ApplicationContainer sinkApp = packetSink.Install (sta.Get (0));
193  sinkApp.Start (Seconds (0));
194  sinkApp.Stop (Seconds (4.0));
195 
196  // The packet source is an on-off application on the AP device
197  InetSocketAddress dest (staNodeInterface.GetAddress (0), udpPort);
198  dest.SetTos (m_tos);
199  OnOffHelper onoff ("ns3::UdpSocketFactory", dest);
200  onoff.SetConstantRate (DataRate ("5kbps"), 500);
201  ApplicationContainer sourceApp = onoff.Install (ap.Get (0));
202  sourceApp.Start (Seconds (1.0));
203  sourceApp.Stop (Seconds (4.0));
204 
205  // The first packet will be transmitted at time 1+(500*8)/5000 = 1.8s.
206  // The second packet will be transmitted at time 1.8+(500*8)/5000 = 2.6s.
207  // The third packet will be transmitted at time 2.6+(500*8)/5000 = 3.4s.
208 
209  Simulator::Stop (Seconds (5.0));
210 
211  Ptr<QueueDisc> root = ap.Get (0)->GetObject<TrafficControlLayer> ()->GetRootQueueDiscOnDevice (apDev.Get (0));
212  NS_TEST_ASSERT_MSG_EQ (root->GetNQueueDiscClasses (), 4, "The root queue disc should have 4 classes");
213  // Get the four child queue discs and connect their Enqueue trace to the PacketEnqueuedInQueueDisc
214  // method, which counts how many packets with the given ToS value have been enqueued
215  root->GetQueueDiscClass (0)->GetQueueDisc ()->TraceConnectWithoutContext ("Enqueue",
217 
218  root->GetQueueDiscClass (1)->GetQueueDisc ()->TraceConnectWithoutContext ("Enqueue",
220 
221  root->GetQueueDiscClass (2)->GetQueueDisc ()->TraceConnectWithoutContext ("Enqueue",
223 
224  root->GetQueueDiscClass (3)->GetQueueDisc ()->TraceConnectWithoutContext ("Enqueue",
226 
227  Ptr<WifiMac> apMac = DynamicCast<WifiNetDevice> (apDev.Get (0))->GetMac ();
228  PointerValue ptr;
229  // Get the four wifi mac queues and connect their Enqueue trace to the PacketEnqueuedInWifiMacQueue
230  // method, which counts how many packets with the given ToS value have been enqueued
231  apMac->GetAttribute ("BE_Txop", ptr);
232  ptr.Get<QosTxop> ()->GetWifiMacQueue ()->TraceConnectWithoutContext ("Enqueue",
234 
235  apMac->GetAttribute ("BK_Txop", ptr);
236  ptr.Get<QosTxop> ()->GetWifiMacQueue ()->TraceConnectWithoutContext ("Enqueue",
238 
239  apMac->GetAttribute ("VI_Txop", ptr);
240  ptr.Get<QosTxop> ()->GetWifiMacQueue ()->TraceConnectWithoutContext ("Enqueue",
242 
243  apMac->GetAttribute ("VO_Txop", ptr);
244  ptr.Get<QosTxop> ()->GetWifiMacQueue ()->TraceConnectWithoutContext ("Enqueue",
246 
247  Simulator::Run ();
248 
249  for (uint32_t i = 0; i < 4; i++)
250  {
251  if (i == m_expectedQueue)
252  {
253  NS_TEST_ASSERT_MSG_GT_OR_EQ (m_QueueDiscCount[i], 1, "There is no packet in the expected queue disc " << i);
254  NS_TEST_ASSERT_MSG_GT_OR_EQ (m_WifiMacQueueCount[i], 1, "There is no packet in the expected Wifi MAC queue " << i);
255  }
256  else
257  {
258  NS_TEST_ASSERT_MSG_EQ (m_QueueDiscCount[i], 0, "Unexpectedly, there is a packet in queue disc " << i);
259  NS_TEST_ASSERT_MSG_EQ (m_WifiMacQueueCount[i], 0, "Unexpectedly, there is a packet in Wifi MAC queue " << i);
260  }
261  }
262 
263  uint32_t totalOctetsThrough =
264  DynamicCast<PacketSink> (sinkApp.Get (0))->GetTotalRx ();
265 
266  // Check that the three packets have been received
267  NS_TEST_ASSERT_MSG_EQ (totalOctetsThrough, 1500, "Three packets should have been received");
268 
269  Simulator::Destroy ();
270 }
271 
279 {
280 public:
282 };
283 
285  : TestSuite ("wifi-ac-mapping", SYSTEM)
286 {
287  AddTestCase (new WifiAcMappingTest (0xb8, 2), TestCase::QUICK); // EF in AC_VI
288  AddTestCase (new WifiAcMappingTest (0x28, 1), TestCase::QUICK); // AF11 in AC_BK
289  AddTestCase (new WifiAcMappingTest (0x70, 0), TestCase::QUICK); // AF32 in AC_BE
290  AddTestCase (new WifiAcMappingTest (0xc0, 3), TestCase::QUICK); // CS7 in AC_VO
291 }
292 
Test for User priority to Access Category mapping.
static void PacketEnqueuedInWifiMacQueue(uint8_t tos, uint16_t *count, Ptr< const WifiMacQueueItem > item)
Function called whenever a packet is enqueued in a Wi-Fi MAC queue.
uint16_t m_WifiMacQueueCount[4]
packet counter per Wi-Fi MAC queue
WifiAcMappingTest(uint8_t tos, uint8_t expectedQueue)
Constructor for WifiAcMappingTest.
uint8_t m_tos
type of service
static void PacketEnqueuedInQueueDisc(uint8_t tos, uint16_t *count, Ptr< const QueueDiscItem > item)
Function called whenever a packet is enqueued in a queue disc.
uint16_t m_expectedQueue
expected queue disc index
uint16_t m_QueueDiscCount[4]
packet counter per queue disc
virtual void DoRun(void)
Implementation to actually run this TestCase.
Access category mapping Test Suite.
holds a vector of ns3::Application pointers.
Ptr< Application > Get(uint32_t i) const
Get the Ptr<Application> stored in this container at a given index.
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
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
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.
Packet header for IPv4.
Definition: ipv4-header.h:34
uint8_t GetTos(void) const
Definition: ipv4-header.cc:194
holds a vector of std::pair of Ptr<Ipv4> and interface index.
Ipv4Address GetAddress(uint32_t i, uint32_t j=0) const
Header for the LLC/SNAP encapsulation.
uint16_t GetType(void)
Return the Ethertype.
Helper class used to assign positions and mobility models to nodes.
holds a vector of ns3::NetDevice pointers
Ptr< NetDevice > Get(uint32_t i) const
Get the Ptr<NetDevice> stored in this container at a given index.
keep track of a set of node pointers.
void Create(uint32_t n)
Create n nodes and append pointers to them to the end of this NodeContainer.
Ptr< Node > Get(uint32_t i) const
Get the Ptr<Node> stored in this container at a given index.
bool TraceConnectWithoutContext(std::string name, const CallbackBase &cb)
Connect a TraceSource to a Callback without a context.
Definition: object-base.cc:364
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
void SetConstantRate(DataRate dataRate, uint32_t packetSize=512)
Helper function to set a constant rate source.
ApplicationContainer Install(NodeContainer c) const
Install an ns3::OnOffApplication on each node of the input container configured with all the attribut...
uint32_t RemoveHeader(Header &header)
Deserialize and remove the header from the internal buffer.
Definition: packet.cc:280
uint32_t PeekHeader(Header &header) const
Deserialize but does not remove the header from the internal buffer.
Definition: packet.cc:290
A helper to make it easier to instantiate an ns3::PacketSinkApplication on a set of nodes.
ApplicationContainer Install(NodeContainer c) const
Install an ns3::PacketSinkApplication on each node of the input container configured with all the att...
Hold objects of type Ptr<T>.
Definition: pointer.h:37
Ptr< T > Get(void) const
Definition: pointer.h:201
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:74
Handle packet fragmentation and retransmissions for QoS data frames as well as MSDU aggregation (A-MS...
Definition: qos-txop.h:72
Ptr< QueueDiscClass > GetQueueDiscClass(std::size_t i) const
Get the i-th queue disc class.
Definition: queue-disc.cc:660
std::size_t GetNQueueDiscClasses(void) const
Get the number of queue disc classes.
Definition: queue-disc.cc:667
The IEEE 802.11 SSID Information Element.
Definition: ssid.h:36
AttributeValue implementation for Ssid.
Definition: ssid.h:105
Hold variables of type string.
Definition: string.h:41
encapsulates test code
Definition: test.h:994
void AddTestCase(TestCase *testCase, TestDuration duration=QUICK)
Add an individual child TestCase to this test suite.
Definition: test.cc:299
A suite of tests to run.
Definition: test.h:1188
Build a set of QueueDisc objects.
QueueDiscContainer Install(NetDeviceContainer c)
uint16_t SetRootQueueDisc(const std::string &type, Args &&... args)
Helper function used to set a root queue disc of the given type and with the given attributes.
std::vector< uint16_t > ClassIdList
Container type for Class IDs.
ClassIdList AddQueueDiscClasses(uint16_t handle, uint16_t count, const std::string &type, Args &&... args)
Helper function used to add the given number of queue disc classes (of the given type and with the gi...
HandleList AddChildQueueDiscs(uint16_t handle, const ClassIdList &classes, const std::string &type, Args &&... args)
Helper function used to attach a child queue disc (of the given type and with the given attributes) t...
Introspection did not find any typical Config paths.
Hold an unsigned integer type.
Definition: uinteger.h:44
helps to create WifiNetDevice objects
Definition: wifi-helper.h:274
create MAC layers for a ns3::WifiNetDevice.
void SetType(std::string type, Args &&... args)
manage and create wifi channel objects for the YANS model.
Ptr< YansWifiChannel > Create(void) const
Make it easy to create and manage PHY objects for the YANS model.
void SetChannel(Ptr< YansWifiChannel > channel)
#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
#define NS_TEST_ASSERT_MSG_EQ(actual, limit, msg)
Test that an actual and expected (limit) value are equal and report and abort if not.
Definition: test.h:141
#define NS_TEST_ASSERT_MSG_GT_OR_EQ(actual, limit, msg)
Test that an actual value is greater than or equal to a limit and report and abort if not.
Definition: test.h:862
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1244
address
Definition: first.py:44
stack
Definition: first.py:41
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ssid
Definition: third.py:100
wifi
Definition: third.py:96
mobility
Definition: third.py:108
static WifiAcMappingTestSuite wifiAcMappingTestSuite