A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
lena-x2-handover.cc
Go to the documentation of this file.
1 /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2012 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
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: Manuel Requena <manuel.requena@cttc.es>
19  */
20 
21 #include "ns3/core-module.h"
22 #include "ns3/network-module.h"
23 #include "ns3/internet-module.h"
24 #include "ns3/mobility-module.h"
25 #include "ns3/lte-module.h"
26 #include "ns3/applications-module.h"
27 #include "ns3/point-to-point-module.h"
28 #include "ns3/config-store-module.h"
29 
30 using namespace ns3;
31 
32 NS_LOG_COMPONENT_DEFINE ("LenaX2HandoverExample");
33 
34 void
35 NotifyConnectionEstablishedUe (std::string context,
36  uint64_t imsi,
37  uint16_t cellid,
38  uint16_t rnti)
39 {
40  std::cout << Simulator::Now ().GetSeconds () << " " << context
41  << " UE IMSI " << imsi
42  << ": connected to CellId " << cellid
43  << " with RNTI " << rnti
44  << std::endl;
45 }
46 
47 void
48 NotifyHandoverStartUe (std::string context,
49  uint64_t imsi,
50  uint16_t cellid,
51  uint16_t rnti,
52  uint16_t targetCellId)
53 {
54  std::cout << Simulator::Now ().GetSeconds () << " " << context
55  << " UE IMSI " << imsi
56  << ": previously connected to CellId " << cellid
57  << " with RNTI " << rnti
58  << ", doing handover to CellId " << targetCellId
59  << std::endl;
60 }
61 
62 void
63 NotifyHandoverEndOkUe (std::string context,
64  uint64_t imsi,
65  uint16_t cellid,
66  uint16_t rnti)
67 {
68  std::cout << Simulator::Now ().GetSeconds () << " " << context
69  << " UE IMSI " << imsi
70  << ": successful handover to CellId " << cellid
71  << " with RNTI " << rnti
72  << std::endl;
73 }
74 
75 void
76 NotifyConnectionEstablishedEnb (std::string context,
77  uint64_t imsi,
78  uint16_t cellid,
79  uint16_t rnti)
80 {
81  std::cout << Simulator::Now ().GetSeconds () << " " << context
82  << " eNB CellId " << cellid
83  << ": successful connection of UE with IMSI " << imsi
84  << " RNTI " << rnti
85  << std::endl;
86 }
87 
88 void
89 NotifyHandoverStartEnb (std::string context,
90  uint64_t imsi,
91  uint16_t cellid,
92  uint16_t rnti,
93  uint16_t targetCellId)
94 {
95  std::cout << Simulator::Now ().GetSeconds () << " " << context
96  << " eNB CellId " << cellid
97  << ": start handover of UE with IMSI " << imsi
98  << " RNTI " << rnti
99  << " to CellId " << targetCellId
100  << std::endl;
101 }
102 
103 void
104 NotifyHandoverEndOkEnb (std::string context,
105  uint64_t imsi,
106  uint16_t cellid,
107  uint16_t rnti)
108 {
109  std::cout << Simulator::Now ().GetSeconds () << " " << context
110  << " eNB CellId " << cellid
111  << ": completed handover of UE with IMSI " << imsi
112  << " RNTI " << rnti
113  << std::endl;
114 }
115 
116 
122 int
123 main (int argc, char *argv[])
124 {
125  // LogLevel logLevel = (LogLevel)(LOG_PREFIX_FUNC | LOG_PREFIX_TIME | LOG_LEVEL_ALL);
126 
127  // LogComponentEnable ("LteHelper", logLevel);
128  // LogComponentEnable ("EpcHelper", logLevel);
129  // LogComponentEnable ("EpcEnbApplication", logLevel);
130  // LogComponentEnable ("EpcX2", logLevel);
131  // LogComponentEnable ("EpcSgwPgwApplication", logLevel);
132 
133  // LogComponentEnable ("LteEnbRrc", logLevel);
134  // LogComponentEnable ("LteEnbNetDevice", logLevel);
135  // LogComponentEnable ("LteUeRrc", logLevel);
136  // LogComponentEnable ("LteUeNetDevice", logLevel);
137 
138  uint16_t numberOfUes = 1;
139  uint16_t numberOfEnbs = 2;
140  uint16_t numBearersPerUe = 2;
141  double simTime = 0.300;
142  double distance = 100.0;
143 
144  // change some default attributes so that they are reasonable for
145  // this scenario, but do this before processing command line
146  // arguments, so that the user is allowed to override these settings
147  Config::SetDefault ("ns3::UdpClient::Interval", TimeValue (MilliSeconds (10)));
148  Config::SetDefault ("ns3::UdpClient::MaxPackets", UintegerValue (1000000));
149  Config::SetDefault ("ns3::LteHelper::UseIdealRrc", BooleanValue (false));
150 
151  // Command line arguments
152  CommandLine cmd;
153  cmd.AddValue ("numberOfUes", "Number of UEs", numberOfUes);
154  cmd.AddValue ("numberOfEnbs", "Number of eNodeBs", numberOfEnbs);
155  cmd.AddValue ("simTime", "Total duration of the simulation (in seconds)", simTime);
156  cmd.Parse (argc, argv);
157 
158 
159  Ptr<LteHelper> lteHelper = CreateObject<LteHelper> ();
160  Ptr<PointToPointEpcHelper> epcHelper = CreateObject<PointToPointEpcHelper> ();
161  lteHelper->SetEpcHelper (epcHelper);
162  lteHelper->SetSchedulerType ("ns3::RrFfMacScheduler");
163  lteHelper->SetHandoverAlgorithmType ("ns3::NoOpHandoverAlgorithm"); // disable automatic handover
164 
165  Ptr<Node> pgw = epcHelper->GetPgwNode ();
166 
167  // Create a single RemoteHost
168  NodeContainer remoteHostContainer;
169  remoteHostContainer.Create (1);
170  Ptr<Node> remoteHost = remoteHostContainer.Get (0);
171  InternetStackHelper internet;
172  internet.Install (remoteHostContainer);
173 
174  // Create the Internet
175  PointToPointHelper p2ph;
176  p2ph.SetDeviceAttribute ("DataRate", DataRateValue (DataRate ("100Gb/s")));
177  p2ph.SetDeviceAttribute ("Mtu", UintegerValue (1500));
178  p2ph.SetChannelAttribute ("Delay", TimeValue (Seconds (0.010)));
179  NetDeviceContainer internetDevices = p2ph.Install (pgw, remoteHost);
180  Ipv4AddressHelper ipv4h;
181  ipv4h.SetBase ("1.0.0.0", "255.0.0.0");
182  Ipv4InterfaceContainer internetIpIfaces = ipv4h.Assign (internetDevices);
183  Ipv4Address remoteHostAddr = internetIpIfaces.GetAddress (1);
184 
185 
186  // Routing of the Internet Host (towards the LTE network)
187  Ipv4StaticRoutingHelper ipv4RoutingHelper;
188  Ptr<Ipv4StaticRouting> remoteHostStaticRouting = ipv4RoutingHelper.GetStaticRouting (remoteHost->GetObject<Ipv4> ());
189  // interface 0 is localhost, 1 is the p2p device
190  remoteHostStaticRouting->AddNetworkRouteTo (Ipv4Address ("7.0.0.0"), Ipv4Mask ("255.0.0.0"), 1);
191 
192  NodeContainer ueNodes;
193  NodeContainer enbNodes;
194  enbNodes.Create (numberOfEnbs);
195  ueNodes.Create (numberOfUes);
196 
197  // Install Mobility Model
198  Ptr<ListPositionAllocator> positionAlloc = CreateObject<ListPositionAllocator> ();
199  for (uint16_t i = 0; i < numberOfEnbs; i++)
200  {
201  positionAlloc->Add (Vector (distance * 2 * i - distance, 0, 0));
202  }
203  for (uint16_t i = 0; i < numberOfUes; i++)
204  {
205  positionAlloc->Add (Vector (0, 0, 0));
206  }
207  MobilityHelper mobility;
208  mobility.SetMobilityModel ("ns3::ConstantPositionMobilityModel");
209  mobility.SetPositionAllocator (positionAlloc);
210  mobility.Install (enbNodes);
211  mobility.Install (ueNodes);
212 
213  // Install LTE Devices in eNB and UEs
214  NetDeviceContainer enbLteDevs = lteHelper->InstallEnbDevice (enbNodes);
215  NetDeviceContainer ueLteDevs = lteHelper->InstallUeDevice (ueNodes);
216 
217  // Install the IP stack on the UEs
218  internet.Install (ueNodes);
219  Ipv4InterfaceContainer ueIpIfaces;
220  ueIpIfaces = epcHelper->AssignUeIpv4Address (NetDeviceContainer (ueLteDevs));
221  // Assign IP address to UEs, and install applications
222  for (uint32_t u = 0; u < ueNodes.GetN (); ++u)
223  {
224  Ptr<Node> ueNode = ueNodes.Get (u);
225  // Set the default gateway for the UE
226  Ptr<Ipv4StaticRouting> ueStaticRouting = ipv4RoutingHelper.GetStaticRouting (ueNode->GetObject<Ipv4> ());
227  ueStaticRouting->SetDefaultRoute (epcHelper->GetUeDefaultGatewayAddress (), 1);
228  }
229 
230 
231  // Attach all UEs to the first eNodeB
232  for (uint16_t i = 0; i < numberOfUes; i++)
233  {
234  lteHelper->Attach (ueLteDevs.Get (i), enbLteDevs.Get (0));
235  }
236 
237 
238  NS_LOG_LOGIC ("setting up applications");
239 
240  // Install and start applications on UEs and remote host
241  uint16_t dlPort = 10000;
242  uint16_t ulPort = 20000;
243 
244  // randomize a bit start times to avoid simulation artifacts
245  // (e.g., buffer overflows due to packet transmissions happening
246  // exactly at the same time)
247  Ptr<UniformRandomVariable> startTimeSeconds = CreateObject<UniformRandomVariable> ();
248  startTimeSeconds->SetAttribute ("Min", DoubleValue (0));
249  startTimeSeconds->SetAttribute ("Max", DoubleValue (0.010));
250 
251  for (uint32_t u = 0; u < numberOfUes; ++u)
252  {
253  Ptr<Node> ue = ueNodes.Get (u);
254  // Set the default gateway for the UE
255  Ptr<Ipv4StaticRouting> ueStaticRouting = ipv4RoutingHelper.GetStaticRouting (ue->GetObject<Ipv4> ());
256  ueStaticRouting->SetDefaultRoute (epcHelper->GetUeDefaultGatewayAddress (), 1);
257 
258  for (uint32_t b = 0; b < numBearersPerUe; ++b)
259  {
260  ++dlPort;
261  ++ulPort;
262 
265 
266  NS_LOG_LOGIC ("installing UDP DL app for UE " << u);
267  UdpClientHelper dlClientHelper (ueIpIfaces.GetAddress (u), dlPort);
268  clientApps.Add (dlClientHelper.Install (remoteHost));
269  PacketSinkHelper dlPacketSinkHelper ("ns3::UdpSocketFactory",
271  serverApps.Add (dlPacketSinkHelper.Install (ue));
272 
273  NS_LOG_LOGIC ("installing UDP UL app for UE " << u);
274  UdpClientHelper ulClientHelper (remoteHostAddr, ulPort);
275  clientApps.Add (ulClientHelper.Install (ue));
276  PacketSinkHelper ulPacketSinkHelper ("ns3::UdpSocketFactory",
278  serverApps.Add (ulPacketSinkHelper.Install (remoteHost));
279 
280  Ptr<EpcTft> tft = Create<EpcTft> ();
282  dlpf.localPortStart = dlPort;
283  dlpf.localPortEnd = dlPort;
284  tft->Add (dlpf);
286  ulpf.remotePortStart = ulPort;
287  ulpf.remotePortEnd = ulPort;
288  tft->Add (ulpf);
290  lteHelper->ActivateDedicatedEpsBearer (ueLteDevs.Get (u), bearer, tft);
291 
292  Time startTime = Seconds (startTimeSeconds->GetValue ());
293  serverApps.Start (startTime);
294  clientApps.Start (startTime);
295 
296  } // end for b
297  }
298 
299 
300  // Add X2 inteface
301  lteHelper->AddX2Interface (enbNodes);
302 
303  // X2-based Handover
304  lteHelper->HandoverRequest (Seconds (0.100), ueLteDevs.Get (0), enbLteDevs.Get (0), enbLteDevs.Get (1));
305 
306  // Uncomment to enable PCAP tracing
307  //p2ph.EnablePcapAll("lena-x2-handover");
308 
309  lteHelper->EnablePhyTraces ();
310  lteHelper->EnableMacTraces ();
311  lteHelper->EnableRlcTraces ();
312  lteHelper->EnablePdcpTraces ();
313  Ptr<RadioBearerStatsCalculator> rlcStats = lteHelper->GetRlcStats ();
314  rlcStats->SetAttribute ("EpochDuration", TimeValue (Seconds (0.05)));
315  Ptr<RadioBearerStatsCalculator> pdcpStats = lteHelper->GetPdcpStats ();
316  pdcpStats->SetAttribute ("EpochDuration", TimeValue (Seconds (0.05)));
317 
318 
319  // connect custom trace sinks for RRC connection establishment and handover notification
320  Config::Connect ("/NodeList/*/DeviceList/*/LteEnbRrc/ConnectionEstablished",
322  Config::Connect ("/NodeList/*/DeviceList/*/LteUeRrc/ConnectionEstablished",
324  Config::Connect ("/NodeList/*/DeviceList/*/LteEnbRrc/HandoverStart",
326  Config::Connect ("/NodeList/*/DeviceList/*/LteUeRrc/HandoverStart",
328  Config::Connect ("/NodeList/*/DeviceList/*/LteEnbRrc/HandoverEndOk",
330  Config::Connect ("/NodeList/*/DeviceList/*/LteUeRrc/HandoverEndOk",
332 
333 
334  Simulator::Stop (Seconds (simTime));
335  Simulator::Run ();
336 
337  // GtkConfigStore config;
338  // config.ConfigureAttributes ();
339 
341  return 0;
342 
343 }
holds a vector of ns3::Application pointers.
uint8_t Add(PacketFilter f)
add a PacketFilter to the Traffic Flow Template
Definition: epc-tft.cc:157
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:79
an Inet address class
static Ipv4Address GetAny(void)
Hold a bool native type.
Definition: boolean.h:38
NetDeviceContainer InstallEnbDevice(NodeContainer c)
create a set of eNB devices
Definition: lte-helper.cc:346
holds a vector of std::pair of Ptr and interface index.
void SetDefaultRoute(Ipv4Address nextHop, uint32_t interface, uint32_t metric=0)
Add a default route to the static routing table.
void HandoverRequest(Time hoTime, Ptr< NetDevice > ueDev, Ptr< NetDevice > sourceEnbDev, Ptr< NetDevice > targetEnbDev)
Manually trigger an X2-based handover of a UE between two eNBs at a specific simulation time...
Definition: lte-helper.cc:877
Ptr< NetDevice > Get(uint32_t i) const
Get the Ptr stored in this container at a given index.
NetDeviceContainer Install(NodeContainer c)
a class to represent an Ipv4 address mask
Definition: ipv4-address.h:222
void Add(ApplicationContainer other)
Append the contents of another ApplicationContainer to the end of this container. ...
static void Run(void)
Run the simulation until one of:
Definition: simulator.cc:157
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:646
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:170
void EnableRlcTraces(void)
Enable trace sinks for RLC layer.
Definition: lte-helper.cc:956
aggregate IP/TCP/UDP functionality to existing Nodes.
A helper to make it easier to instantiate an ns3::PacketSinkApplication on a set of nodes...
Build a set of PointToPointNetDevice objects.
void Connect(std::string path, const CallbackBase &cb)
Definition: config.cc:728
void NotifyConnectionEstablishedEnb(std::string context, uint64_t imsi, uint16_t cellid, uint16_t rnti)
void SetDeviceAttribute(std::string name, const AttributeValue &value)
Set an attribute value to be propagated to each NetDevice created by the helper.
a 3d vector
Definition: vector.h:31
void SetHandoverAlgorithmType(std::string type)
Definition: lte-helper.cc:237
ApplicationContainer Install(NodeContainer c)
void NotifyHandoverEndOkUe(std::string context, uint64_t imsi, uint16_t cellid, uint16_t rnti)
tuple clientApps
Definition: first.py:53
void SetSchedulerType(std::string type)
Definition: lte-helper.cc:210
uint32_t GetN(void) const
Get the number of Ptr stored in this container.
Class for representing data rates.
Definition: data-rate.h:71
void EnablePdcpTraces(void)
Enable trace sinks for PDCP layer.
Definition: lte-helper.cc:1093
double GetSeconds(void) const
Definition: nstime.h:272
This class contains the specification of EPS Bearers.
Definition: eps-bearer.h:71
void Install(Ptr< Node > node) const
"Layout" a single node according to the current position allocator type.
Create a client application which sends UDP packets carrying a 32bit sequence number and a 64 bit tim...
hold objects of type ns3::Time
Definition: nstime.h:1008
Hold an unsigned integer type.
Definition: uinteger.h:46
double startTime
void NotifyConnectionEstablishedUe(std::string context, uint64_t imsi, uint16_t cellid, uint16_t rnti)
holds a vector of ns3::NetDevice pointers
void EnablePhyTraces(void)
Enable trace sinks for PHY layer.
Definition: lte-helper.cc:1004
Callback< R > MakeCallback(R(T::*memPtr)(void), OBJ objPtr)
Definition: callback.h:1242
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:177
#define NS_LOG_LOGIC(msg)
Use NS_LOG to output a message of level LOG_LOGIC.
Definition: log.h:233
static void Destroy(void)
Every event scheduled by the Simulator::insertAtDestroy method is invoked.
Definition: simulator.cc:121
void NotifyHandoverEndOkEnb(std::string context, uint64_t imsi, uint16_t cellid, uint16_t rnti)
tuple serverApps
Definition: first.py:44
Access to the Ipv4 forwarding table, interfaces, and configuration.
Definition: ipv4.h:76
uint16_t remotePortEnd
end of the port number range of the remote host
Definition: epc-tft.h:113
void SetDefault(std::string name, const AttributeValue &value)
Definition: config.cc:667
void ActivateDedicatedEpsBearer(NetDeviceContainer ueDevices, EpsBearer bearer, Ptr< EpcTft > tft)
Activate a dedicated EPS bearer on a given set of UE devices.
Definition: lte-helper.cc:754
keep track of a set of node pointers.
void SetMobilityModel(std::string type, std::string n1="", const AttributeValue &v1=EmptyAttributeValue(), std::string n2="", const AttributeValue &v2=EmptyAttributeValue(), std::string n3="", const AttributeValue &v3=EmptyAttributeValue(), std::string n4="", const AttributeValue &v4=EmptyAttributeValue(), std::string n5="", const AttributeValue &v5=EmptyAttributeValue(), std::string n6="", const AttributeValue &v6=EmptyAttributeValue(), std::string n7="", const AttributeValue &v7=EmptyAttributeValue(), std::string n8="", const AttributeValue &v8=EmptyAttributeValue(), std::string n9="", const AttributeValue &v9=EmptyAttributeValue())
double GetValue(double min, double max)
Returns a random double from the uniform distribution with the specified range.
void Install(std::string nodeName) const
Aggregate implementations of the ns3::Ipv4, ns3::Ipv6, ns3::Udp, and ns3::Tcp classes onto the provid...
void AddX2Interface(NodeContainer enbNodes)
Create an X2 interface between all the eNBs in a given set.
Definition: lte-helper.cc:852
static Time Now(void)
Return the "current simulation time".
Definition: simulator.cc:180
int main(int argc, char *argv[])
Sample simulation script for a X2-based handover.
void SetChannelAttribute(std::string name, const AttributeValue &value)
Set an attribute value to be propagated to each Channel created by the helper.
Ptr< RadioBearerStatsCalculator > GetRlcStats(void)
Definition: lte-helper.cc:1087
NetDeviceContainer InstallUeDevice(NodeContainer c)
create a set of UE devices
Definition: lte-helper.cc:361
Ptr< RadioBearerStatsCalculator > GetPdcpStats(void)
Definition: lte-helper.cc:1101
Helper class used to assign positions and mobility models to nodes.
void AddNetworkRouteTo(Ipv4Address network, Ipv4Mask networkMask, Ipv4Address nextHop, uint32_t interface, uint32_t metric=0)
Add a network route to the static routing table.
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:38
Ipv4InterfaceContainer Assign(const NetDeviceContainer &c)
Assign IP addresses to the net devices specified in the container based on the current network prefix...
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...
void SetEpcHelper(Ptr< EpcHelper > h)
Set the EpcHelper to be used to setup the EPC network in conjunction with the setup of the LTE radio ...
Definition: lte-helper.cc:203
Helper class that adds ns3::Ipv4StaticRouting objects.
hold objects of type ns3::DataRate
void AddValue(const std::string &name, const std::string &help, T &value)
Add a program argument, assigning to POD.
Definition: command-line.h:435
static void Stop(void)
If an event invokes this method, it will be the last event scheduled by the Simulator::run method bef...
Definition: simulator.cc:165
Ptr< Node > Get(uint32_t i) const
Get the Ptr stored in this container at a given index.
ApplicationContainer Install(NodeContainer c) const
Install an ns3::PacketSinkApplication on each node of the input container configured with all the att...
void Parse(int argc, char *argv[])
Parse the program arguments.
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
void Create(uint32_t n)
Create n nodes and append pointers to them to the end of this NodeContainer.
void NotifyHandoverStartUe(std::string context, uint64_t imsi, uint16_t cellid, uint16_t rnti, uint16_t targetCellId)
void EnableMacTraces(void)
Enable trace sinks for MAC layer.
Definition: lte-helper.cc:1044
void NotifyHandoverStartEnb(std::string context, uint64_t imsi, uint16_t cellid, uint16_t rnti, uint16_t targetCellId)
void SetPositionAllocator(Ptr< PositionAllocator > allocator)
Set the position allocator which will be used to allocate the initial position of every node initiali...
Hold a floating point type.
Definition: double.h:41
void SetAttribute(std::string name, const AttributeValue &value)
Definition: object-base.cc:176
Ptr< T > GetObject(void) const
Definition: object.h:362
uint16_t remotePortStart
start of the port number range of the remote host
Definition: epc-tft.h:112
void SetBase(Ipv4Address network, Ipv4Mask mask, Ipv4Address base="0.0.0.1")
Set the base network number, network mask and base address.
Implement the data structure representing a TrafficFlowTemplate Packet Filter.
Definition: epc-tft.h:73
Ipv4Address GetAddress(uint32_t i, uint32_t j=0) const
uint16_t localPortStart
start of the port number range of the UE
Definition: epc-tft.h:114