A Discrete-Event Network Simulator
API
lena-simple-epc-backhaul.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019 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: Manuel Requena <manuel.requena@cttc.es>
18  */
19 
20 #include "ns3/applications-module.h"
21 #include "ns3/config-store.h"
22 #include "ns3/core-module.h"
23 #include "ns3/internet-module.h"
24 #include "ns3/lte-module.h"
25 #include "ns3/mobility-module.h"
26 #include "ns3/network-module.h"
27 #include "ns3/point-to-point-module.h"
28 // #include "ns3/gtk-config-store.h"
29 
30 using namespace ns3;
31 
48 NS_LOG_COMPONENT_DEFINE("LenaSimpleEpcBackhaul");
49 
50 int
51 main(int argc, char* argv[])
52 {
53  uint16_t numNodePairs = 2;
54  Time simTime = MilliSeconds(1900);
55  double distance = 60.0;
56  Time interPacketInterval = MilliSeconds(100);
57  bool disableDl = false;
58  bool disableUl = false;
59  bool useHelper = false;
60 
61  // Command line arguments
62  CommandLine cmd(__FILE__);
63  cmd.AddValue("numNodePairs", "Number of eNodeBs + UE pairs", numNodePairs);
64  cmd.AddValue("simTime", "Total duration of the simulation", simTime);
65  cmd.AddValue("distance", "Distance between eNBs [m]", distance);
66  cmd.AddValue("interPacketInterval", "Inter packet interval", interPacketInterval);
67  cmd.AddValue("disableDl", "Disable downlink data flows", disableDl);
68  cmd.AddValue("disableUl", "Disable uplink data flows", disableUl);
69  cmd.AddValue("useHelper",
70  "Build the backhaul network using the helper or "
71  "it is built in the example",
72  useHelper);
73  cmd.Parse(argc, argv);
74 
75  ConfigStore inputConfig;
76  inputConfig.ConfigureDefaults();
77 
78  // parse again so you can override default values from the command line
79  cmd.Parse(argc, argv);
80 
81  Ptr<LteHelper> lteHelper = CreateObject<LteHelper>();
82  Ptr<EpcHelper> epcHelper;
83  if (!useHelper)
84  {
85  epcHelper = CreateObject<NoBackhaulEpcHelper>();
86  }
87  else
88  {
89  epcHelper = CreateObject<PointToPointEpcHelper>();
90  }
91  lteHelper->SetEpcHelper(epcHelper);
92 
93  Ptr<Node> pgw = epcHelper->GetPgwNode();
94 
95  // Create a single RemoteHost
96  NodeContainer remoteHostContainer;
97  remoteHostContainer.Create(1);
98  Ptr<Node> remoteHost = remoteHostContainer.Get(0);
100  internet.Install(remoteHostContainer);
101 
102  // Create the Internet
103  PointToPointHelper p2ph;
104  p2ph.SetDeviceAttribute("DataRate", DataRateValue(DataRate("100Gb/s")));
105  p2ph.SetDeviceAttribute("Mtu", UintegerValue(1500));
106  p2ph.SetChannelAttribute("Delay", TimeValue(MilliSeconds(10)));
107  NetDeviceContainer internetDevices = p2ph.Install(pgw, remoteHost);
108  Ipv4AddressHelper ipv4h;
109  ipv4h.SetBase("1.0.0.0", "255.0.0.0");
110  Ipv4InterfaceContainer internetIpIfaces = ipv4h.Assign(internetDevices);
111  // interface 0 is localhost, 1 is the p2p device
112  Ipv4Address remoteHostAddr = internetIpIfaces.GetAddress(1);
113 
114  Ipv4StaticRoutingHelper ipv4RoutingHelper;
115  Ptr<Ipv4StaticRouting> remoteHostStaticRouting =
116  ipv4RoutingHelper.GetStaticRouting(remoteHost->GetObject<Ipv4>());
117  remoteHostStaticRouting->AddNetworkRouteTo(Ipv4Address("7.0.0.0"), Ipv4Mask("255.0.0.0"), 1);
118 
119  NodeContainer ueNodes;
120  NodeContainer enbNodes;
121  enbNodes.Create(numNodePairs);
122  ueNodes.Create(numNodePairs);
123 
124  // Install Mobility Model for eNBs and UEs
125  Ptr<ListPositionAllocator> positionAlloc = CreateObject<ListPositionAllocator>();
126  for (uint16_t i = 0; i < numNodePairs; i++)
127  {
128  positionAlloc->Add(Vector(distance * i, 0, 0));
129  }
131  mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
132  mobility.SetPositionAllocator(positionAlloc);
133  mobility.Install(enbNodes);
134  mobility.Install(ueNodes);
135 
136  // SGW node
137  Ptr<Node> sgw = epcHelper->GetSgwNode();
138 
139  // Install Mobility Model for SGW
140  Ptr<ListPositionAllocator> positionAlloc2 = CreateObject<ListPositionAllocator>();
141  positionAlloc2->Add(Vector(0.0, 50.0, 0.0));
142  MobilityHelper mobility2;
143  mobility2.SetMobilityModel("ns3::ConstantPositionMobilityModel");
144  mobility2.SetPositionAllocator(positionAlloc2);
145  mobility2.Install(sgw);
146 
147  // Install LTE Devices to the nodes
148  NetDeviceContainer enbLteDevs = lteHelper->InstallEnbDevice(enbNodes);
149  NetDeviceContainer ueLteDevs = lteHelper->InstallUeDevice(ueNodes);
150 
151  if (!useHelper)
152  {
153  Ipv4AddressHelper s1uIpv4AddressHelper;
154 
155  // Create networks of the S1 interfaces
156  s1uIpv4AddressHelper.SetBase("10.0.0.0", "255.255.255.252");
157 
158  for (uint16_t i = 0; i < numNodePairs; ++i)
159  {
160  Ptr<Node> enb = enbNodes.Get(i);
161  std::vector<uint16_t> cellIds(1, i + 1);
162 
163  // Create a point to point link between the eNB and the SGW with
164  // the corresponding new NetDevices on each side
165  PointToPointHelper p2ph;
166  DataRate s1uLinkDataRate = DataRate("10Gb/s");
167  uint16_t s1uLinkMtu = 2000;
168  Time s1uLinkDelay = Time(0);
169  p2ph.SetDeviceAttribute("DataRate", DataRateValue(s1uLinkDataRate));
170  p2ph.SetDeviceAttribute("Mtu", UintegerValue(s1uLinkMtu));
171  p2ph.SetChannelAttribute("Delay", TimeValue(s1uLinkDelay));
172  NetDeviceContainer sgwEnbDevices = p2ph.Install(sgw, enb);
173 
174  Ipv4InterfaceContainer sgwEnbIpIfaces = s1uIpv4AddressHelper.Assign(sgwEnbDevices);
175  s1uIpv4AddressHelper.NewNetwork();
176 
177  Ipv4Address sgwS1uAddress = sgwEnbIpIfaces.GetAddress(0);
178  Ipv4Address enbS1uAddress = sgwEnbIpIfaces.GetAddress(1);
179 
180  // Create S1 interface between the SGW and the eNB
181  epcHelper->AddS1Interface(enb, enbS1uAddress, sgwS1uAddress, cellIds);
182  }
183  }
184 
185  // Install the IP stack on the UEs
186  internet.Install(ueNodes);
187  Ipv4InterfaceContainer ueIpIface;
188  ueIpIface = epcHelper->AssignUeIpv4Address(NetDeviceContainer(ueLteDevs));
189  // Assign IP address to UEs, and install applications
190  for (uint32_t u = 0; u < ueNodes.GetN(); ++u)
191  {
192  Ptr<Node> ueNode = ueNodes.Get(u);
193  // Set the default gateway for the UE
194  Ptr<Ipv4StaticRouting> ueStaticRouting =
195  ipv4RoutingHelper.GetStaticRouting(ueNode->GetObject<Ipv4>());
196  ueStaticRouting->SetDefaultRoute(epcHelper->GetUeDefaultGatewayAddress(), 1);
197  }
198 
199  // Attach one UE per eNodeB
200  for (uint16_t i = 0; i < numNodePairs; i++)
201  {
202  lteHelper->Attach(ueLteDevs.Get(i), enbLteDevs.Get(i));
203  // side effect: the default EPS bearer will be activated
204  }
205 
206  // Install and start applications on UEs and remote host
207  uint16_t dlPort = 1100;
208  uint16_t ulPort = 2000;
211  for (uint32_t u = 0; u < ueNodes.GetN(); ++u)
212  {
213  if (!disableDl)
214  {
215  PacketSinkHelper dlPacketSinkHelper("ns3::UdpSocketFactory",
217  serverApps.Add(dlPacketSinkHelper.Install(ueNodes.Get(u)));
218 
219  UdpClientHelper dlClient(ueIpIface.GetAddress(u), dlPort);
220  dlClient.SetAttribute("Interval", TimeValue(interPacketInterval));
221  dlClient.SetAttribute("MaxPackets", UintegerValue(1000000));
222  clientApps.Add(dlClient.Install(remoteHost));
223  }
224 
225  if (!disableUl)
226  {
227  ++ulPort;
228  PacketSinkHelper ulPacketSinkHelper("ns3::UdpSocketFactory",
230  serverApps.Add(ulPacketSinkHelper.Install(remoteHost));
231 
232  UdpClientHelper ulClient(remoteHostAddr, ulPort);
233  ulClient.SetAttribute("Interval", TimeValue(interPacketInterval));
234  ulClient.SetAttribute("MaxPackets", UintegerValue(1000000));
235  clientApps.Add(ulClient.Install(ueNodes.Get(u)));
236  }
237  }
238 
239  serverApps.Start(MilliSeconds(500));
240  clientApps.Start(MilliSeconds(500));
241  lteHelper->EnableTraces();
242  // Uncomment to enable PCAP tracing
243  // p2ph.EnablePcapAll("lena-simple-epc-backhaul");
244 
245  Simulator::Stop(simTime);
246  Simulator::Run();
247 
248  /*GtkConfigStore config;
249  config.ConfigureAttributes();*/
250 
252  return 0;
253 }
holds a vector of ns3::Application pointers.
Parse command-line arguments.
Definition: command-line.h:232
void ConfigureDefaults()
Configure the default values.
Class for representing data rates.
Definition: data-rate.h:89
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.
Ipv4Address NewNetwork()
Increment the network number and reset the IP address counter to the base value provided in the SetBa...
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.
Definition: ipv4-address.h:42
static Ipv4Address GetAny()
Access to the IPv4 forwarding table, interfaces, and configuration.
Definition: ipv4.h:80
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
Definition: ipv4-address.h:257
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...
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:285
NetDeviceContainer InstallEnbDevice(NodeContainer c)
Create a set of eNodeB devices.
Definition: lte-helper.cc:485
void EnableTraces()
Enables trace sinks for PHY, MAC, RLC and PDCP.
Definition: lte-helper.cc:1549
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:1039
NetDeviceContainer InstallUeDevice(NodeContainer c)
Create a set of UE devices.
Definition: lte-helper.cc:500
Helper class used to assign positions and mobility models to nodes.
void Install(Ptr< Node > node) const
"Layout" a single node according to the current position allocator type.
void SetMobilityModel(std::string type, Ts &&... args)
void SetPositionAllocator(Ptr< PositionAllocator > allocator)
Set the position allocator which will be used to allocate the initial position of every node initiali...
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:471
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)
static void Destroy()
Execute the events scheduled with ScheduleDestroy().
Definition: simulator.cc:142
static void Run()
Run the simulation.
Definition: simulator.cc:178
static void Stop()
Tell the Simulator the calling event should be the last one executed.
Definition: simulator.cc:186
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:105
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:45
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
void(* DataRate)(DataRate oldValue, DataRate newValue)
TracedValue callback signature for DataRate.
Definition: data-rate.h:327
Time MilliSeconds(uint64_t value)
Construct a Time in the indicated unit.
Definition: nstime.h:1338
serverApps
Definition: first.py:54
clientApps
Definition: first.py:64
void(* Time)(Time oldValue, Time newValue)
TracedValue callback signature for Time.
Definition: nstime.h:839
Every class exported by the ns3 library is enclosed in the ns3 namespace.
cmd
Definition: second.py:40
mobility
Definition: third.py:105