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