A Discrete-Event Network Simulator
API
lte-test-aggregation-throughput-scale.cc
Go to the documentation of this file.
1/*
2 * Copyright (c) 2017 Alexander Krotov
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: Alexander Krotov <krotov@iitp.ru>
18 *
19 */
20
22
23#include <ns3/application-container.h>
24#include <ns3/friis-spectrum-propagation-loss.h>
25#include <ns3/internet-stack-helper.h>
26#include <ns3/ipv4-address-helper.h>
27#include <ns3/ipv4-interface-container.h>
28#include <ns3/ipv4-static-routing-helper.h>
29#include <ns3/log.h>
30#include <ns3/lte-enb-net-device.h>
31#include <ns3/lte-helper.h>
32#include <ns3/lte-ue-net-device.h>
33#include <ns3/lte-ue-rrc.h>
34#include <ns3/mobility-helper.h>
35#include <ns3/net-device-container.h>
36#include <ns3/node-container.h>
37#include <ns3/packet-sink.h>
38#include <ns3/point-to-point-epc-helper.h>
39#include <ns3/point-to-point-helper.h>
40#include <ns3/simulator.h>
41#include <ns3/udp-client.h>
42
43#include <algorithm>
44#include <numeric>
45
46using namespace ns3;
47
48NS_LOG_COMPONENT_DEFINE("LteAggregationThroughputScaleTest");
49
51 : TestSuite("lte-aggregation-throughput-scale", SYSTEM)
52{
53 AddTestCase(new LteAggregationThroughputScaleTestCase("Carrier aggregation throughput scale"),
54 TestCase::QUICK);
55}
56
58
60 : TestCase(name)
61{
62 NS_LOG_FUNCTION(this << GetName());
63}
64
66{
67 NS_LOG_FUNCTION(this << GetName());
68}
69
70double
72{
73 NS_LOG_FUNCTION(this << GetName());
74
75 Config::SetDefault("ns3::LteEnbNetDevice::DlEarfcn", UintegerValue(100));
76 Config::SetDefault("ns3::LteEnbNetDevice::UlEarfcn", UintegerValue(100 + 18000));
77 Config::SetDefault("ns3::LteEnbNetDevice::DlBandwidth", UintegerValue(25));
78 Config::SetDefault("ns3::LteEnbNetDevice::UlBandwidth", UintegerValue(25));
79 Config::SetDefault("ns3::LteUeNetDevice::DlEarfcn", UintegerValue(100));
80
81 auto lteHelper = CreateObject<LteHelper>();
82 lteHelper->SetAttribute("PathlossModel",
84 lteHelper->SetAttribute("NumberOfComponentCarriers", UintegerValue(numberOfComponentCarriers));
85 lteHelper->SetAttribute("EnbComponentCarrierManager",
86 StringValue("ns3::RrComponentCarrierManager"));
87
88 auto epcHelper = CreateObject<PointToPointEpcHelper>();
89 lteHelper->SetEpcHelper(epcHelper);
90
91 auto enbNode = CreateObject<Node>();
92 auto ueNode = CreateObject<Node>();
93 auto pgwNode = epcHelper->GetPgwNode();
94
96 mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
97 mobility.Install(enbNode);
98 mobility.Install(ueNode);
99
100 InternetStackHelper internet;
101 internet.Install(ueNode);
102
103 Ipv4AddressHelper ipv4h;
104 ipv4h.SetBase("1.0.0.0", "255.0.0.0");
105
106 Ipv4StaticRoutingHelper ipv4RoutingHelper;
107 auto ueStaticRouting = ipv4RoutingHelper.GetStaticRouting(ueNode->GetObject<Ipv4>());
108 ueStaticRouting->SetDefaultRoute(epcHelper->GetUeDefaultGatewayAddress(), 1);
109
110 auto enbDev = DynamicCast<LteEnbNetDevice>(lteHelper->InstallEnbDevice(enbNode).Get(0));
111 auto ueDevs = lteHelper->InstallUeDevice(ueNode);
112 auto ueDev = DynamicCast<LteUeNetDevice>(ueDevs.Get(0));
113
114 Ipv4InterfaceContainer ueIpIface = epcHelper->AssignUeIpv4Address(ueDevs);
115
116 // Attach to last CC as primary
117 std::map<uint8_t, Ptr<ComponentCarrierUe>> ueCcMap = ueDev->GetCcMap();
118 ueDev->SetDlEarfcn(ueCcMap.at(numberOfComponentCarriers - 1)->GetDlEarfcn());
119 lteHelper->Attach(ueDevs);
120 m_expectedCellId = enbDev->GetCcMap().at(numberOfComponentCarriers - 1)->GetCellId();
121
122 // Applications
123 const uint16_t port = 21;
124
126
127 auto sink = CreateObject<PacketSink>();
128 sink->SetAttribute("Protocol", StringValue("ns3::UdpSocketFactory"));
130 ueNode->AddApplication(sink);
131 apps.Add(sink);
132
133 auto client = CreateObject<UdpClient>();
134 client->SetAttribute("RemotePort", UintegerValue(port));
135 client->SetAttribute("MaxPackets", UintegerValue(1000000));
136 client->SetAttribute("Interval", TimeValue(Seconds(0.0001)));
137 client->SetAttribute("PacketSize", UintegerValue(1000));
138 client->SetAttribute("RemoteAddress", AddressValue(ueIpIface.GetAddress(0)));
139 pgwNode->AddApplication(client);
140
141 apps.Add(client);
142 apps.Start(Seconds(1.0));
143
144 Simulator::Stop(Seconds(2.0));
145 Simulator::Run();
146
147 m_actualCellId = ueDev->GetRrc()->GetCellId();
148
149 Simulator::Destroy();
150 return 8e-6 * sink->GetTotalRx();
151}
152
153void
155{
156 std::vector<double> throughputs;
157 for (uint8_t i = 1; i <= 4; i++)
158 {
159 throughputs.push_back(GetThroughput(i) / i);
162 "UE has attached to an unexpected cell");
163 }
164 double average =
165 std::accumulate(begin(throughputs), end(throughputs), 0.0) / throughputs.size();
166 for (double throughput : throughputs)
167 {
168 NS_TEST_ASSERT_MSG_EQ_TOL(throughput,
169 average,
170 average * 0.01,
171 "Throughput does not scale with number of component carriers");
172 }
173}
Testing that UE throughput scales linearly with number of component carriers.
void DoRun() override
Setup the simulation, run it, and verify the result.
double GetThroughput(uint8_t numberOfComponentCarriers)
Get throughput function.
uint16_t m_expectedCellId
Cell ID UE is expected to attach to.
LteAggregationThroughputScaleTestCase(std::string name)
Creates an instance of the carrier aggregation throughput scaling test case.
Test suite for executing carrier aggregation throughput scaling test case.
AttributeValue implementation for Address.
holds a vector of ns3::Application pointers.
void Start(Time start)
Arrange for all of the Applications in this container to Start() at the Time given as a parameter.
void Add(ApplicationContainer other)
Append the contents of another ApplicationContainer to the end of this container.
an Inet address class
aggregate IP/TCP/UDP functionality to existing Nodes.
void Install(std::string nodeName) const
Aggregate implementations of the ns3::Ipv4, ns3::Ipv6, ns3::Udp, and ns3::Tcp classes onto the provid...
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.
Access to the IPv4 forwarding table, interfaces, and configuration.
Definition: ipv4.h:79
holds a vector of std::pair of Ptr<Ipv4> and interface index.
Ipv4Address GetAddress(uint32_t i, uint32_t j=0) const
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...
Helper class used to assign positions and mobility models to nodes.
void SetAttribute(std::string name, const AttributeValue &value)
Set a single attribute, raising fatal errors if unsuccessful.
Definition: object-base.cc:258
uint64_t GetTotalRx() const
Definition: packet-sink.cc:96
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 GetName() const
Definition: test.cc:377
A suite of tests to run.
Definition: test.h:1256
AttributeValue implementation for Time.
Definition: nstime.h:1425
AttributeValue implementation for TypeId.
Definition: type-id.h:600
Hold an unsigned integer type.
Definition: uinteger.h:45
uint16_t port
Definition: dsdv-manet.cc:45
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_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
#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:144
#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 LteAggregationThroughputScaleTestSuite g_lteAggregationThroughputScaleTestSuite
Every class exported by the ns3 library is enclosed in the ns3 namespace.
mobility
Definition: third.py:96
Ptr< PacketSink > sink
Pointer to the packet sink application.
Definition: wifi-tcp.cc:55