A Discrete-Event Network Simulator
API
lte-test-harq.cc
Go to the documentation of this file.
1/*
2 * Copyright (c) 2011 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation;
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 *
17 * Author: Marco Miozzo <marco.miozzo@cttc.es>
18 */
19
20#include "lte-test-harq.h"
21
22#include <ns3/boolean.h>
23#include <ns3/buildings-helper.h>
24#include <ns3/config.h>
25#include <ns3/double.h>
26#include <ns3/enum.h>
27#include <ns3/eps-bearer.h>
28#include <ns3/ff-mac-scheduler.h>
29#include <ns3/hybrid-buildings-propagation-loss-model.h>
30#include <ns3/log.h>
31#include <ns3/lte-enb-net-device.h>
32#include <ns3/lte-enb-phy.h>
33#include <ns3/lte-helper.h>
34#include <ns3/lte-ue-net-device.h>
35#include <ns3/lte-ue-phy.h>
36#include <ns3/lte-ue-rrc.h>
37#include <ns3/mobility-building-info.h>
38#include <ns3/mobility-helper.h>
39#include <ns3/net-device-container.h>
40#include <ns3/node-container.h>
41#include <ns3/object.h>
42#include <ns3/packet.h>
43#include <ns3/ptr.h>
44#include <ns3/radio-bearer-stats-calculator.h>
45#include <ns3/simulator.h>
46#include <ns3/spectrum-error-model.h>
47#include <ns3/spectrum-interference.h>
48#include <ns3/string.h>
49#include <ns3/test.h>
50
51#include <cmath>
52#include <iostream>
53
54using namespace ns3;
55
56NS_LOG_COMPONENT_DEFINE("LenaTestHarq");
57
59 : TestSuite("lte-harq", SYSTEM)
60{
61 NS_LOG_INFO("creating LenaTestHarqTestCase");
62
63 // Tests on DL/UL Data channels (PDSCH, PUSCH)
64 // MCS 0 TB size of 66 bytes SINR -9.91 dB expected throughput 31822 bytes/s
65 // TBLER 1st tx 1.0
66 // TBLER 2nd tx 0.074
67 AddTestCase(new LenaHarqTestCase(2, 2400, 66, 0.12, 31822), TestCase::QUICK);
68
69 // Tests on DL/UL Data channels (PDSCH, PUSCH)
70 // MCS 10 TB size of 472 bytes SINR 0.3 dB expected throughput 209964 bytes/s
71 // TBLER 1st tx 1.0
72 // TBLER 2nd tx 0.248
73 AddTestCase(new LenaHarqTestCase(1, 770, 472, 0.06, 209964), TestCase::QUICK);
74}
75
77
78std::string
79LenaHarqTestCase::BuildNameString(uint16_t nUser, uint16_t dist, uint16_t tbSize)
80{
81 std::ostringstream oss;
82 oss << nUser << " UEs, distance " << dist << " m, TB size " << tbSize;
83 return oss.str();
84}
85
87 uint16_t dist,
88 uint16_t tbSize,
89 double amcBer,
90 double thrRef)
91 : TestCase(BuildNameString(nUser, dist, tbSize)),
92 m_nUser(nUser),
93 m_dist(dist),
94 m_amcBer(amcBer),
95 m_throughputRef(thrRef)
96{
97}
98
100{
101}
102
103void
105{
106 Config::SetDefault("ns3::LteAmc::Ber", DoubleValue(m_amcBer));
107 Config::SetDefault("ns3::LteAmc::AmcModel", EnumValue(LteAmc::PiroEW2010));
108 Config::SetDefault("ns3::LteSpectrumPhy::CtrlErrorModelEnabled", BooleanValue(false));
109 Config::SetDefault("ns3::LteSpectrumPhy::DataErrorModelEnabled", BooleanValue(true));
110 Config::SetDefault("ns3::LteHelper::UseIdealRrc", BooleanValue(true));
111 Config::SetDefault("ns3::MacStatsCalculator::DlOutputFilename",
112 StringValue(CreateTempDirFilename("DlMacStats.txt")));
113 Config::SetDefault("ns3::MacStatsCalculator::UlOutputFilename",
114 StringValue(CreateTempDirFilename("UlMacStats.txt")));
115 Config::SetDefault("ns3::RadioBearerStatsCalculator::DlRlcOutputFilename",
116 StringValue(CreateTempDirFilename("DlRlcStats.txt")));
117 Config::SetDefault("ns3::RadioBearerStatsCalculator::UlRlcOutputFilename",
118 StringValue(CreateTempDirFilename("UlRlcStats.txt")));
119
120 // Disable Uplink Power Control
121 Config::SetDefault("ns3::LteUePhy::EnableUplinkPowerControl", BooleanValue(false));
122
123 // Config::SetDefault ("ns3::RrFfMacScheduler::HarqEnabled", BooleanValue (false));
124 // LogComponentEnable ("LteEnbRrc", LOG_LEVEL_ALL);
125 // LogComponentEnable ("LteUeRrc", LOG_LEVEL_ALL);
126 // LogComponentEnable ("LteEnbMac", LOG_LEVEL_ALL);
127 // LogComponentEnable ("LteUeMac", LOG_LEVEL_ALL);
128 // LogComponentEnable ("LteRlc", LOG_LEVEL_ALL);
129 //
130 // LogComponentEnable ("LtePhy", LOG_LEVEL_ALL);
131 // LogComponentEnable ("LteEnbPhy", LOG_LEVEL_ALL);
132 // LogComponentEnable ("LteUePhy", LOG_LEVEL_ALL);
133
134 // LogComponentEnable ("LteSpectrumPhy", LOG_LEVEL_ALL);
135 // LogComponentEnable ("LteInterference", LOG_LEVEL_ALL);
136 // LogComponentEnable ("LteChunkProcessor", LOG_LEVEL_ALL);
137 //
138 // LogComponentEnable ("LtePropagationLossModel", LOG_LEVEL_ALL);
139 // LogComponentEnable ("LossModel", LOG_LEVEL_ALL);
140 // LogComponentEnable ("ShadowingLossModel", LOG_LEVEL_ALL);
141 // LogComponentEnable ("PenetrationLossModel", LOG_LEVEL_ALL);
142 // LogComponentEnable ("MultipathLossModel", LOG_LEVEL_ALL);
143 // LogComponentEnable ("PathLossModel", LOG_LEVEL_ALL);
144 //
145 // LogComponentEnable ("LteNetDevice", LOG_LEVEL_ALL);
146 // LogComponentEnable ("LteUeNetDevice", LOG_LEVEL_ALL);
147 // LogComponentEnable ("LteEnbNetDevice", LOG_LEVEL_ALL);
148
149 // LogComponentEnable ("RrFfMacScheduler", LOG_LEVEL_ALL);
150 // LogComponentEnable ("LenaHelper", LOG_LEVEL_ALL);
151 // LogComponentEnable ("RlcStatsCalculator", LOG_LEVEL_ALL);
152
153 // LogComponentEnable ("LteSpectrumPhy", LOG_LEVEL_ALL);
154 // LogComponentEnable ("LteEnbMac", LOG_LEVEL_ALL);
155 // LogComponentEnable ("LteEnbPhy", LOG_LEVEL_ALL);
156 // LogComponentEnable ("LteUePhy", LOG_LEVEL_ALL);
157 // LogComponentEnable ("RrFfMacScheduler", LOG_LEVEL_ALL);
158 // LogComponentEnable ("LenaHelper", LOG_LEVEL_ALL);
159 // LogComponentEnable ("BuildingsPropagationLossModel", LOG_LEVEL_ALL);
160 // LogComponentEnable ("LteMiErrorModel", LOG_LEVEL_ALL);
161 // LogComponentEnable ("LteAmc", LOG_LEVEL_ALL);
162 //
163 // LogComponentDisableAll (LOG_LEVEL_ALL);
164
165 // LogComponentEnable ("LenaTestHarq", LOG_LEVEL_ALL);
166
171 Ptr<LteHelper> lena = CreateObject<LteHelper>();
172
173 // Create Nodes: eNodeB and UE
174 NodeContainer enbNodes;
175 NodeContainer ueNodes;
176 enbNodes.Create(1);
177 ueNodes.Create(m_nUser);
178
179 // Install Mobility Model
181 mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
182 mobility.Install(enbNodes);
183 BuildingsHelper::Install(enbNodes);
184
185 mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
186 mobility.Install(ueNodes);
187 BuildingsHelper::Install(ueNodes);
188
189 // remove random shadowing component
190 lena->SetAttribute("PathlossModel", StringValue("ns3::HybridBuildingsPropagationLossModel"));
191 lena->SetPathlossModelAttribute("ShadowSigmaOutdoor", DoubleValue(0.0));
192 lena->SetPathlossModelAttribute("ShadowSigmaIndoor", DoubleValue(0.0));
193 lena->SetPathlossModelAttribute("ShadowSigmaExtWalls", DoubleValue(0.0));
194
195 // Create Devices and install them in the Nodes (eNB and UE)
196 NetDeviceContainer enbDevs;
197 NetDeviceContainer ueDevs;
198 lena->SetSchedulerType("ns3::RrFfMacScheduler");
199 lena->SetSchedulerAttribute("UlCqiFilter", EnumValue(FfMacScheduler::PUSCH_UL_CQI));
200
201 enbDevs = lena->InstallEnbDevice(enbNodes);
202 ueDevs = lena->InstallUeDevice(ueNodes);
203
204 // Attach a UE to a eNB
205 lena->Attach(ueDevs, enbDevs.Get(0));
206
207 // Activate an EPS bearer
208 enum EpsBearer::Qci q = EpsBearer::GBR_CONV_VOICE;
209 EpsBearer bearer(q);
210 lena->ActivateDataRadioBearer(ueDevs, bearer);
211
212 Ptr<LteEnbNetDevice> lteEnbDev = enbDevs.Get(0)->GetObject<LteEnbNetDevice>();
213 Ptr<LteEnbPhy> enbPhy = lteEnbDev->GetPhy();
214 enbPhy->SetAttribute("TxPower", DoubleValue(43.0));
215 enbPhy->SetAttribute("NoiseFigure", DoubleValue(5.0));
216 // place the HeNB over the default rooftop level (20 mt.)
217 Ptr<MobilityModel> mm = enbNodes.Get(0)->GetObject<MobilityModel>();
218 mm->SetPosition(Vector(0.0, 0.0, 30.0));
219
220 // Set UEs' position and power
221 for (int i = 0; i < m_nUser; i++)
222 {
223 Ptr<MobilityModel> mm = ueNodes.Get(i)->GetObject<MobilityModel>();
224 mm->SetPosition(Vector(m_dist, 0.0, 1.0));
225 Ptr<LteUeNetDevice> lteUeDev = ueDevs.Get(i)->GetObject<LteUeNetDevice>();
226 Ptr<LteUePhy> uePhy = lteUeDev->GetPhy();
227 uePhy->SetAttribute("TxPower", DoubleValue(23.0));
228 uePhy->SetAttribute("NoiseFigure", DoubleValue(9.0));
229 }
230
231 double statsStartTime = 0.050; // need to allow for RRC connection establishment + SRS
232 double statsDuration = 2.0;
233 Simulator::Stop(Seconds(statsStartTime + statsDuration - 0.0001));
234
235 lena->EnableRlcTraces();
237 rlcStats->SetAttribute("StartTime", TimeValue(Seconds(statsStartTime)));
238 rlcStats->SetAttribute("EpochDuration", TimeValue(Seconds(statsDuration)));
239
240 // for debugging purposes
241 lena->EnableMacTraces();
242
243 Simulator::Run();
244
248 NS_LOG_INFO("\tTest on downlink data shared channels (PDSCH)");
249 NS_LOG_INFO("Test with " << m_nUser << " user(s) at distance " << m_dist << " expected Thr "
250 << m_throughputRef);
251 for (int i = 0; i < m_nUser; i++)
252 {
253 // get the imsi
254 uint64_t imsi = ueDevs.Get(i)->GetObject<LteUeNetDevice>()->GetImsi();
255 uint8_t lcId = 3;
256 double txed = rlcStats->GetDlTxData(imsi, lcId);
257 double rxed = rlcStats->GetDlRxData(imsi, lcId);
258 double tolerance = 0.1;
259
260 NS_LOG_INFO(" User " << i << " imsi " << imsi << " bytes rxed/t " << rxed / statsDuration
261 << " txed/t " << txed / statsDuration << " thr Ref " << m_throughputRef
262 << " Err "
263 << (std::abs(txed / statsDuration - m_throughputRef)) /
265
266 NS_TEST_ASSERT_MSG_EQ_TOL(txed / statsDuration,
268 m_throughputRef * tolerance,
269 " Unexpected Throughput!");
270 NS_TEST_ASSERT_MSG_EQ_TOL(rxed / statsDuration,
272 m_throughputRef * tolerance,
273 " Unexpected Throughput!");
274 }
275
276 Simulator::Destroy();
277}
This system test program creates different test cases with a single eNB and several UEs,...
Definition: lte-test-harq.h:39
double m_throughputRef
throughput reference
Definition: lte-test-harq.h:67
void DoRun() override
Implementation to actually run this TestCase.
uint16_t m_dist
distance between nodes
Definition: lte-test-harq.h:65
uint16_t m_nUser
number of UE nodes
Definition: lte-test-harq.h:64
static std::string BuildNameString(uint16_t nUser, uint16_t dist, uint16_t tbSize)
Build name string function.
LenaHarqTestCase(uint16_t nUser, uint16_t dist, uint16_t tbSize, double amcBer, double thrRef)
Constructor.
~LenaHarqTestCase() override
double m_amcBer
AMC bit error rate.
Definition: lte-test-harq.h:66
Test suite for harq test.
Definition: lte-test-harq.h:78
AttributeValue implementation for Boolean.
Definition: boolean.h:37
This class can be used to hold variables of floating point type such as 'double' or 'float'.
Definition: double.h:42
Hold variables of type enum.
Definition: enum.h:56
This class contains the specification of EPS Bearers.
Definition: eps-bearer.h:91
Qci
QoS Class Indicator.
Definition: eps-bearer.h:106
The eNodeB device implementation.
Ptr< LteEnbPhy > GetPhy() const
Ptr< RadioBearerStatsCalculator > GetRlcStats()
Definition: lte-helper.cc:1708
void SetSchedulerAttribute(std::string n, const AttributeValue &v)
Set an attribute for the scheduler to be created.
Definition: lte-helper.cc:303
NetDeviceContainer InstallEnbDevice(NodeContainer c)
Create a set of eNodeB devices.
Definition: lte-helper.cc:482
void SetSchedulerType(std::string type)
Set the type of scheduler to be used by eNodeB devices.
Definition: lte-helper.cc:289
void Attach(NetDeviceContainer ueDevices)
Enables automatic attachment of a set of UE devices to a suitable cell using Idle mode initial cell s...
Definition: lte-helper.cc:1044
void SetPathlossModelAttribute(std::string n, const AttributeValue &v)
Set an attribute for the path loss models to be created.
Definition: lte-helper.cc:402
void EnableRlcTraces()
Enable trace sinks for RLC layer.
Definition: lte-helper.cc:1563
void ActivateDataRadioBearer(NetDeviceContainer ueDevices, EpsBearer bearer)
Activate a Data Radio Bearer on a given UE devices (for LTE-only simulation).
Definition: lte-helper.cc:1441
NetDeviceContainer InstallUeDevice(NodeContainer c)
Create a set of UE devices.
Definition: lte-helper.cc:497
void EnableMacTraces()
Enable trace sinks for MAC layer.
Definition: lte-helper.cc:1666
The LteUeNetDevice class implements the UE net device.
Helper class used to assign positions and mobility models to nodes.
Keep track of the current position and velocity of an object.
void SetPosition(const Vector &position)
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.
void SetAttribute(std::string name, const AttributeValue &value)
Set a single attribute, raising fatal errors if unsuccessful.
Definition: object-base.cc:258
Ptr< T > GetObject() const
Get a pointer to the requested aggregated Object.
Definition: object.h:471
Hold variables of type string.
Definition: string.h:42
encapsulates test code
Definition: test.h:1060
void AddTestCase(TestCase *testCase, TestDuration duration=QUICK)
Add an individual child TestCase to this test suite.
Definition: test.cc:305
std::string CreateTempDirFilename(std::string filename)
Construct the full path to a file in a temporary directory.
Definition: test.cc:442
A suite of tests to run.
Definition: test.h:1256
AttributeValue implementation for Time.
Definition: nstime.h:1425
void SetDefault(std::string name, const AttributeValue &value)
Definition: config.cc:891
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition: log.h:275
#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:337
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1338
static LenaTestHarqSuite lenaTestHarqSuite
Every class exported by the ns3 library is enclosed in the ns3 namespace.
mobility
Definition: third.py:96