A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
lte-test-deactivate-bearer.cc
Go to the documentation of this file.
1/*
2 * Copyright (c) 2011, 2012 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
3 *
4 * SPDX-License-Identifier: GPL-2.0-only
5 *
6 * Author:Gaurav Sathe <gaurav.sathe@tcs.com>
7 */
8
10
11#include "ns3/double.h"
12#include "ns3/internet-module.h"
13#include "ns3/ipv4-global-routing-helper.h"
14#include "ns3/network-module.h"
15#include "ns3/packet-sink-helper.h"
16#include "ns3/point-to-point-epc-helper.h"
17#include "ns3/point-to-point-helper.h"
18#include "ns3/radio-bearer-stats-calculator.h"
19#include "ns3/string.h"
20#include "ns3/udp-client-server-helper.h"
21#include <ns3/boolean.h>
22#include <ns3/constant-position-mobility-model.h>
23#include <ns3/enum.h>
24#include <ns3/eps-bearer.h>
25#include <ns3/log.h>
26#include <ns3/lte-enb-net-device.h>
27#include <ns3/lte-enb-phy.h>
28#include <ns3/lte-helper.h>
29#include <ns3/lte-ue-net-device.h>
30#include <ns3/lte-ue-phy.h>
31#include <ns3/lte-ue-rrc.h>
32#include <ns3/mobility-helper.h>
33#include <ns3/net-device-container.h>
34#include <ns3/node-container.h>
35#include <ns3/object.h>
36#include <ns3/packet.h>
37#include <ns3/ptr.h>
38#include <ns3/rng-seed-manager.h>
39#include <ns3/simulator.h>
40#include <ns3/spectrum-error-model.h>
41#include <ns3/spectrum-interference.h>
42#include <ns3/test.h>
43
44#include <iostream>
45#include <sstream>
46#include <string>
47
48NS_LOG_COMPONENT_DEFINE("LenaTestDeactivateBearer");
49
50namespace ns3
51{
52
54 : TestSuite("lte-test-deactivate-bearer", Type::SYSTEM)
55{
56 NS_LOG_INFO("creating LenaTestPssFfMacSchedulerSuite");
57
58 bool errorModel = false;
59
60 // Test Case: homogeneous flow test in PSS (different distance)
61 // Traffic1 info
62 // UDP traffic: payload size = 100 bytes, interval = 1 ms
63 // UDP rate in scheduler: (payload + RLC header + PDCP header + IP header + UDP header) * 1000
64 // byte/sec -> 132000 byte/rate
65 // Maximum throughput = 3 / ( 1/2196000 + 1/1191000 + 1/1383000) = 1486569 byte/s
66 // 132000 * 3 = 396000 < 1209046 -> estimated throughput in downlink = 132000 byte/sec
67 std::vector<uint16_t> dist_1;
68
69 dist_1.push_back(0); // User 0 distance --> MCS 28
70 dist_1.push_back(0); // User 1 distance --> MCS 22
71 dist_1.push_back(0); // User 2 distance --> MCS 20
72
73 std::vector<uint16_t> packetSize_1;
74
75 packetSize_1.push_back(100); // 1
76 packetSize_1.push_back(100); // 2
77 packetSize_1.push_back(100); // 3
78
79 std::vector<uint32_t> estThrPssDl_1;
80
81 estThrPssDl_1.push_back(132000); // User 0 estimated TTI throughput from PSS
82 estThrPssDl_1.push_back(132000); // User 1 estimated TTI throughput from PSS
83 estThrPssDl_1.push_back(132000); // User 2 estimated TTI throughput from PSS
84
86 new LenaDeactivateBearerTestCase(dist_1, estThrPssDl_1, packetSize_1, 1, errorModel, true),
88}
89
90/**
91 * @ingroup lte-test
92 * Static variable for test initialization
93 */
95
96std::string
97LenaDeactivateBearerTestCase::BuildNameString(uint16_t nUser, std::vector<uint16_t> dist)
98{
99 std::ostringstream oss;
100 oss << "distances (m) = [ ";
101 for (auto it = dist.begin(); it != dist.end(); ++it)
102 {
103 oss << *it << " ";
104 }
105 oss << "]";
106 return oss.str();
107}
108
110 std::vector<uint32_t> estThrPssDl,
111 std::vector<uint16_t> packetSize,
112 uint16_t interval,
113 bool errorModelEnabled,
114 bool useIdealRrc)
115 : TestCase(BuildNameString(dist.size(), dist)),
116 m_nUser(dist.size()),
117 m_dist(dist),
118 m_packetSize(packetSize),
119 m_interval(interval),
120 m_estThrPssDl(estThrPssDl),
121 m_errorModelEnabled(errorModelEnabled)
122{
123}
124
128
129void
131{
132 uint32_t originalSeed = RngSeedManager::GetSeed();
133 uint32_t originalRun = RngSeedManager::GetRun();
136
138 {
139 Config::SetDefault("ns3::LteSpectrumPhy::CtrlErrorModelEnabled", BooleanValue(false));
140 Config::SetDefault("ns3::LteSpectrumPhy::DataErrorModelEnabled", BooleanValue(false));
141 }
142
143 Config::SetDefault("ns3::LteHelper::UseIdealRrc", BooleanValue(true));
144 Config::SetDefault("ns3::RadioBearerStatsCalculator::DlRlcOutputFilename",
145 StringValue(CreateTempDirFilename("DlRlcStats.txt")));
146 Config::SetDefault("ns3::RadioBearerStatsCalculator::UlRlcOutputFilename",
147 StringValue(CreateTempDirFilename("UlRlcStats.txt")));
148
151 lteHelper->SetEpcHelper(epcHelper);
152
153 Ptr<Node> pgw = epcHelper->GetPgwNode();
154
155 // Create a single RemoteHost
156 NodeContainer remoteHostContainer;
157 remoteHostContainer.Create(1);
158 Ptr<Node> remoteHost = remoteHostContainer.Get(0);
159 InternetStackHelper internet;
160 internet.Install(remoteHostContainer);
161
162 // Create the Internet
164 p2ph.SetDeviceAttribute("DataRate", DataRateValue(DataRate("100Gb/s")));
165 p2ph.SetDeviceAttribute("Mtu", UintegerValue(1500));
166 p2ph.SetChannelAttribute("Delay", TimeValue(Seconds(0.001)));
167 NetDeviceContainer internetDevices = p2ph.Install(pgw, remoteHost);
168 Ipv4AddressHelper ipv4h;
169 ipv4h.SetBase("1.0.0.0", "255.0.0.0");
170 Ipv4InterfaceContainer internetIpIfaces = ipv4h.Assign(internetDevices);
171 // interface 0 is localhost, 1 is the p2p device
172 Ipv4Address remoteHostAddr = internetIpIfaces.GetAddress(1);
173
174 Ipv4StaticRoutingHelper ipv4RoutingHelper;
175 Ptr<Ipv4StaticRouting> remoteHostStaticRouting =
176 ipv4RoutingHelper.GetStaticRouting(remoteHost->GetObject<Ipv4>());
177 remoteHostStaticRouting->AddNetworkRouteTo(Ipv4Address("7.0.0.0"), Ipv4Mask("255.0.0.0"), 1);
178
179 // LogLevel logLevel = (LogLevel)(LOG_PREFIX_FUNC | LOG_PREFIX_TIME | LOG_LEVEL_ALL);
180
181 // LogComponentEnable ("LenaTestDeactivateBearer", LOG_LEVEL_ALL);
182 // LogComponentEnable ("LteHelper", logLevel);
183 // LogComponentEnable ("EpcHelper", logLevel);
184 // LogComponentEnable ("EpcEnbApplication", logLevel);
185 // LogComponentEnable ("EpcMmeApplication", logLevel);
186 // LogComponentEnable ("EpcPgwApplication", logLevel);
187 // LogComponentEnable ("EpcSgwApplication", logLevel);
188 // LogComponentEnable ("LteEnbRrc", logLevel);
189
190 lteHelper->SetAttribute("PathlossModel", StringValue("ns3::FriisSpectrumPropagationLossModel"));
191
192 // Create Nodes: eNodeB and UE
193 NodeContainer enbNodes;
194 NodeContainer ueNodes;
195 enbNodes.Create(1);
196 ueNodes.Create(m_nUser);
197
198 // Install Mobility Model
199 MobilityHelper mobility;
200 mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
201 mobility.Install(enbNodes);
202 mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
203 mobility.Install(ueNodes);
204
205 // Create Devices and install them in the Nodes (eNB and UE)
206 NetDeviceContainer enbDevs;
207 NetDeviceContainer ueDevs;
208 int64_t stream = 1;
209
210 lteHelper->SetSchedulerType("ns3::PssFfMacScheduler");
211 enbDevs = lteHelper->InstallEnbDevice(enbNodes);
212 stream += lteHelper->AssignStreams(enbDevs, stream);
213
214 ueDevs = lteHelper->InstallUeDevice(ueNodes);
215 stream += lteHelper->AssignStreams(ueDevs, stream);
216
217 Ptr<LteEnbNetDevice> lteEnbDev = enbDevs.Get(0)->GetObject<LteEnbNetDevice>();
218 Ptr<LteEnbPhy> enbPhy = lteEnbDev->GetPhy();
219 enbPhy->SetAttribute("TxPower", DoubleValue(30.0));
220 enbPhy->SetAttribute("NoiseFigure", DoubleValue(5.0));
221
222 // Set UEs' position and power
223 for (int i = 0; i < m_nUser; i++)
224 {
227 mm->SetPosition(Vector(m_dist.at(i), 0.0, 0.0));
228 Ptr<LteUeNetDevice> lteUeDev = ueDevs.Get(i)->GetObject<LteUeNetDevice>();
229 Ptr<LteUePhy> uePhy = lteUeDev->GetPhy();
230 uePhy->SetAttribute("TxPower", DoubleValue(23.0));
231 uePhy->SetAttribute("NoiseFigure", DoubleValue(9.0));
232 }
233
234 // Install the IP stack on the UEs
235 internet.Install(ueNodes);
236 Ipv4InterfaceContainer ueIpIface;
237 ueIpIface = epcHelper->AssignUeIpv4Address(NetDeviceContainer(ueDevs));
238
239 // Assign IP address to UEs
240 for (uint32_t u = 0; u < ueNodes.GetN(); ++u)
241 {
242 Ptr<Node> ueNode = ueNodes.Get(u);
243 // Set the default gateway for the UE
244 Ptr<Ipv4StaticRouting> ueStaticRouting =
245 ipv4RoutingHelper.GetStaticRouting(ueNode->GetObject<Ipv4>());
246 ueStaticRouting->SetDefaultRoute(epcHelper->GetUeDefaultGatewayAddress(), 1);
247 }
248
249 // Attach a UE to a eNB
250 lteHelper->Attach(ueDevs, enbDevs.Get(0));
251
252 // Activate an EPS bearer on all UEs
253
254 for (uint32_t u = 0; u < ueNodes.GetN(); ++u)
255 {
256 Ptr<NetDevice> ueDevice = ueDevs.Get(u);
258 qos.gbrDl = (m_packetSize.at(u) + 32) * (1000 / m_interval) *
259 8; // bit/s, considering IP, UDP, RLC, PDCP header size
260 qos.gbrUl = (m_packetSize.at(u) + 32) * (1000 / m_interval) * 8;
261 qos.mbrDl = qos.gbrDl;
262 qos.mbrUl = qos.gbrUl;
263
265 EpsBearer bearer(q, qos);
266 bearer.arp.priorityLevel = 15 - (u + 1);
267 bearer.arp.preemptionCapability = true;
268 bearer.arp.preemptionVulnerability = true;
269 lteHelper->ActivateDedicatedEpsBearer(ueDevice, bearer, EpcTft::Default());
270 }
271
272 // Install downlink and uplink applications
273 uint16_t dlPort = 1234;
274 uint16_t ulPort = 2000;
275 PacketSinkHelper dlPacketSinkHelper("ns3::UdpSocketFactory",
277 ApplicationContainer clientApps;
278 ApplicationContainer serverApps;
279
280 for (uint32_t u = 0; u < ueNodes.GetN(); ++u)
281 {
282 ++ulPort;
283 serverApps.Add(
284 dlPacketSinkHelper.Install(ueNodes.Get(u))); // receive packets from remotehost
285 PacketSinkHelper ulPacketSinkHelper("ns3::UdpSocketFactory",
287 serverApps.Add(ulPacketSinkHelper.Install(remoteHost)); // receive packets from UEs
288
289 UdpClientHelper dlClient(ueIpIface.GetAddress(u), dlPort); // uplink packets generator
290 dlClient.SetAttribute("Interval", TimeValue(MilliSeconds(m_interval)));
291 dlClient.SetAttribute("MaxPackets", UintegerValue(1000000));
292 dlClient.SetAttribute("PacketSize", UintegerValue(m_packetSize.at(u)));
293
294 UdpClientHelper ulClient(remoteHostAddr, ulPort); // downlink packets generator
295 ulClient.SetAttribute("Interval", TimeValue(MilliSeconds(m_interval)));
296 ulClient.SetAttribute("MaxPackets", UintegerValue(1000000));
297 ulClient.SetAttribute("PacketSize", UintegerValue(m_packetSize.at(u)));
298
299 clientApps.Add(dlClient.Install(remoteHost));
300 clientApps.Add(ulClient.Install(ueNodes.Get(u)));
301 }
302
303 serverApps.Start(Seconds(0.030));
304 clientApps.Start(Seconds(0.030));
305
306 double statsStartTime = 0.04; // need to allow for RRC connection establishment + SRS
307 double statsDuration = 1.0;
308 double tolerance = 0.1;
309
310 lteHelper->EnableRlcTraces();
311 Ptr<RadioBearerStatsCalculator> rlcStats = lteHelper->GetRlcStats();
312 rlcStats->SetAttribute("StartTime", TimeValue(Seconds(statsStartTime)));
313 rlcStats->SetAttribute("EpochDuration", TimeValue(Seconds(statsDuration)));
314
315 // get ue device pointer for UE-ID 0 IMSI 1 and enb device pointer
316 Ptr<NetDevice> ueDevice = ueDevs.Get(0);
317 Ptr<NetDevice> enbDevice = enbDevs.Get(0);
318
319 /*
320 * Instantiate De-activation using Simulator::Schedule() method which will initiate bearer
321 * de-activation after deActivateTime Instantiate De-activation in sequence (Time const &time,
322 * MEM mem_ptr, OBJ obj, T1 a1, T2 a2, T3 a3)
323 */
324 Time deActivateTime(Seconds(1.5));
325 Simulator::Schedule(deActivateTime,
327 lteHelper,
328 ueDevice,
329 enbDevice,
330 2);
331
332 // stop simulation after 3 seconds
334
336
337 NS_LOG_INFO("DL - Test with " << m_nUser << " user(s)");
338 std::vector<uint64_t> dlDataRxed;
339 std::vector<uint64_t> dlDataTxed;
340 for (int i = 0; i < m_nUser; i++)
341 {
342 // get the imsi
343 uint64_t imsi = ueDevs.Get(i)->GetObject<LteUeNetDevice>()->GetImsi();
344 // get the lcId
345 // lcId is hard-coded, since only one dedicated bearer is added
346 uint8_t lcId = 4;
347 dlDataRxed.push_back(rlcStats->GetDlRxData(imsi, lcId));
348 dlDataTxed.push_back(rlcStats->GetDlTxData(imsi, lcId));
349 NS_LOG_INFO("\tUser " << i << " dist " << m_dist.at(i) << " imsi " << imsi << " bytes rxed "
350 << (double)dlDataRxed.at(i) << " thr "
351 << (double)dlDataRxed.at(i) / statsDuration << " ref "
352 << m_estThrPssDl.at(i));
353 NS_LOG_INFO("\tUser " << i << " imsi " << imsi << " bytes txed " << (double)dlDataTxed.at(i)
354 << " thr " << (double)dlDataTxed.at(i) / statsDuration);
355 }
356
357 for (int i = 0; i < m_nUser; i++)
358 {
359 uint64_t imsi = ueDevs.Get(i)->GetObject<LteUeNetDevice>()->GetImsi();
360
361 /*
362 * For UE ID-0 IMSI 1, LCID=4 is deactivated hence If traffic seen on it, test case should
363 * fail Else For other UE's, test case should validate throughput
364 */
365 if (imsi == 1)
366 {
367 NS_TEST_ASSERT_MSG_EQ((double)dlDataTxed.at(i), 0, "Invalid LCID in Statistics ");
368 }
369 else
370 {
371 NS_TEST_ASSERT_MSG_EQ_TOL((double)dlDataTxed.at(i) / statsDuration,
372 m_estThrPssDl.at(i),
373 m_estThrPssDl.at(i) * tolerance,
374 " Unfair Throughput!");
375 }
376 }
377
379
380 RngSeedManager::SetSeed(originalSeed);
381 RngSeedManager::SetRun(originalRun);
382}
383} // namespace ns3
holds a vector of ns3::Application pointers.
ApplicationContainer Install(NodeContainer c)
Install an application on each node of the input container configured with all the attributes set wit...
void SetAttribute(const std::string &name, const AttributeValue &value)
Helper function used to set the underlying application attributes.
AttributeValue implementation for Boolean.
Definition boolean.h:26
Mobility model for which the current position does not change once it has been set and until it is se...
Class for representing data rates.
Definition data-rate.h:78
AttributeValue implementation for DataRate.
Definition data-rate.h:285
This class can be used to hold variables of floating point type such as 'double' or 'float'.
Definition double.h:31
static Ptr< EpcTft > Default()
creates a TFT matching any traffic
Definition epc-tft.cc:218
This class contains the specification of EPS Bearers.
Definition eps-bearer.h:80
AllocationRetentionPriority arp
allocation retention priority
Definition eps-bearer.h:143
Qci
QoS Class Indicator.
Definition eps-bearer.h:95
@ GBR_CONV_VOICE
GBR Conversational Voice.
Definition eps-bearer.h:96
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.
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.
static Ipv4Address GetAny()
Access to the IPv4 forwarding table, interfaces, and configuration.
Definition ipv4.h:69
holds a vector of std::pair of Ptr<Ipv4> and interface index.
Ipv4Address GetAddress(uint32_t i, uint32_t j=0) const
a class to represent an Ipv4 address mask
Helper class that adds ns3::Ipv4StaticRouting objects.
Ptr< Ipv4StaticRouting > GetStaticRouting(Ptr< Ipv4 > ipv4) const
Try and find the static routing protocol as either the main routing protocol or in the list of routin...
Test case that for testing the deactivation of the bearer functionality.
std::vector< uint16_t > m_packetSize
packet size in bytes
void DoRun() override
Implementation to actually run this TestCase.
LenaDeactivateBearerTestCase(std::vector< uint16_t > dist, std::vector< uint32_t > estThrPssDl, std::vector< uint16_t > packetSize, uint16_t interval, bool errorModelEnabled, bool useIdealRrc)
Constructor.
std::vector< uint16_t > m_dist
distance between the nodes
static std::string BuildNameString(uint16_t nUser, std::vector< uint16_t > dist)
Build name string function.
std::vector< uint32_t > m_estThrPssDl
estimated threshold PSS DL
The test suite class for the LenaDeactivateBearerTestCase.
The eNodeB device implementation.
void DeActivateDedicatedEpsBearer(Ptr< NetDevice > ueDevice, Ptr< NetDevice > enbDevice, uint8_t bearerId)
Manually trigger dedicated bearer de-activation at specific simulation time.
The LteUeNetDevice class implements the UE net device.
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.
uint32_t GetN() const
Get the number of Ptr<Node> stored in this container.
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.
Ptr< T > GetObject() const
Get a pointer to the requested aggregated Object.
Definition object.h:511
A helper to make it easier to instantiate an ns3::PacketSinkApplication on a set of nodes.
Build a set of PointToPointNetDevice objects.
void SetDeviceAttribute(std::string name, const AttributeValue &value)
Set an attribute value to be propagated to each NetDevice created by the helper.
void SetChannelAttribute(std::string name, const AttributeValue &value)
Set an attribute value to be propagated to each Channel created by the helper.
NetDeviceContainer Install(NodeContainer c)
Smart pointer class similar to boost::intrusive_ptr.
static void SetRun(uint64_t run)
Set the run number of simulation.
static void SetSeed(uint32_t seed)
Set the seed.
static uint64_t GetRun()
Get the current run number.
static uint32_t GetSeed()
Get the current seed value which will be used by all subsequently instantiated RandomVariableStream o...
static EventId Schedule(const Time &delay, FUNC f, Ts &&... args)
Schedule an event to expire after delay.
Definition simulator.h:560
static void Destroy()
Execute the events scheduled with ScheduleDestroy().
Definition simulator.cc:131
static void Run()
Run the simulation.
Definition simulator.cc:167
static void Stop()
Tell the Simulator the calling event should be the last one executed.
Definition simulator.cc:175
Hold variables of type string.
Definition string.h:45
encapsulates test code
Definition test.h:1050
void AddTestCase(TestCase *testCase, Duration duration=Duration::QUICK)
Add an individual child TestCase to this test suite.
Definition test.cc:292
std::string CreateTempDirFilename(std::string filename)
Construct the full path to a file in a temporary directory.
Definition test.cc:432
A suite of tests to run.
Definition test.h:1267
Type
Type of test.
Definition test.h:1274
Simulation virtual time values and global simulation resolution.
Definition nstime.h:94
AttributeValue implementation for Time.
Definition nstime.h:1431
Create a client application which sends UDP packets carrying a 32bit sequence number and a 64 bit tim...
Hold an unsigned integer type.
Definition uinteger.h:34
void SetDefault(std::string name, const AttributeValue &value)
Definition config.cc:883
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition log.h:191
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition log.h:264
static LenaTestBearerDeactivateSuite lenaTestBearerDeactivateSuite
Static variable for test initialization.
Ptr< T > CreateObject(Args &&... args)
Create an object by type, with varying number of constructor parameters.
Definition object.h:619
#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:134
#define NS_TEST_ASSERT_MSG_EQ_TOL(actual, limit, tol, msg)
Test that actual and expected (limit) values are equal to plus or minus some tolerance and report and...
Definition test.h:327
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition nstime.h:1344
Time MilliSeconds(uint64_t value)
Construct a Time in the indicated unit.
Definition nstime.h:1356
Every class exported by the ns3 library is enclosed in the ns3 namespace.
bool preemptionVulnerability
true if bearer can be preempted by others
Definition eps-bearer.h:49
bool preemptionCapability
true if bearer can preempt others
Definition eps-bearer.h:48
uint8_t priorityLevel
1-15; 1 = highest
Definition eps-bearer.h:47
3GPP TS 36.413 9.2.1.18 GBR QoS Information
Definition eps-bearer.h:25
uint64_t gbrDl
Guaranteed Bit Rate (bit/s) in downlink.
Definition eps-bearer.h:31
uint64_t gbrUl
Guaranteed Bit Rate (bit/s) in uplink.
Definition eps-bearer.h:32
uint64_t mbrDl
Maximum Bit Rate (bit/s) in downlink.
Definition eps-bearer.h:33
uint64_t mbrUl
Maximum Bit Rate (bit/s) in uplink.
Definition eps-bearer.h:34
static const uint32_t packetSize
Packet size generated at the AP.