A Discrete-Event Network Simulator
API
lena-simple-epc.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011-2018 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  * Authors: Jaume Nin <jaume.nin@cttc.cat>
18  * Manuel Requena <manuel.requena@cttc.es>
19  */
20 
21 #include "ns3/applications-module.h"
22 #include "ns3/config-store-module.h"
23 #include "ns3/core-module.h"
24 #include "ns3/internet-module.h"
25 #include "ns3/lte-module.h"
26 #include "ns3/mobility-module.h"
27 #include "ns3/point-to-point-module.h"
28 // #include "ns3/gtk-config-store.h"
29 
30 using namespace ns3;
31 
38 NS_LOG_COMPONENT_DEFINE("LenaSimpleEpc");
39 
40 int
41 main(int argc, char* argv[])
42 {
43  uint16_t numNodePairs = 2;
44  Time simTime = MilliSeconds(1100);
45  double distance = 60.0;
46  Time interPacketInterval = MilliSeconds(100);
47  bool useCa = false;
48  bool disableDl = false;
49  bool disableUl = false;
50  bool disablePl = false;
51 
52  // Command line arguments
53  CommandLine cmd(__FILE__);
54  cmd.AddValue("numNodePairs", "Number of eNodeBs + UE pairs", numNodePairs);
55  cmd.AddValue("simTime", "Total duration of the simulation", simTime);
56  cmd.AddValue("distance", "Distance between eNBs [m]", distance);
57  cmd.AddValue("interPacketInterval", "Inter packet interval", interPacketInterval);
58  cmd.AddValue("useCa", "Whether to use carrier aggregation.", useCa);
59  cmd.AddValue("disableDl", "Disable downlink data flows", disableDl);
60  cmd.AddValue("disableUl", "Disable uplink data flows", disableUl);
61  cmd.AddValue("disablePl", "Disable data flows between peer UEs", disablePl);
62  cmd.Parse(argc, argv);
63 
64  ConfigStore inputConfig;
65  inputConfig.ConfigureDefaults();
66 
67  // parse again so you can override default values from the command line
68  cmd.Parse(argc, argv);
69 
70  if (useCa)
71  {
72  Config::SetDefault("ns3::LteHelper::UseCa", BooleanValue(useCa));
73  Config::SetDefault("ns3::LteHelper::NumberOfComponentCarriers", UintegerValue(2));
74  Config::SetDefault("ns3::LteHelper::EnbComponentCarrierManager",
75  StringValue("ns3::RrComponentCarrierManager"));
76  }
77 
78  Ptr<LteHelper> lteHelper = CreateObject<LteHelper>();
79  Ptr<PointToPointEpcHelper> epcHelper = CreateObject<PointToPointEpcHelper>();
80  lteHelper->SetEpcHelper(epcHelper);
81 
82  Ptr<Node> pgw = epcHelper->GetPgwNode();
83 
84  // Create a single RemoteHost
85  NodeContainer remoteHostContainer;
86  remoteHostContainer.Create(1);
87  Ptr<Node> remoteHost = remoteHostContainer.Get(0);
88  InternetStackHelper internet;
89  internet.Install(remoteHostContainer);
90 
91  // Create the Internet
92  PointToPointHelper p2ph;
93  p2ph.SetDeviceAttribute("DataRate", DataRateValue(DataRate("100Gb/s")));
94  p2ph.SetDeviceAttribute("Mtu", UintegerValue(1500));
95  p2ph.SetChannelAttribute("Delay", TimeValue(MilliSeconds(10)));
96  NetDeviceContainer internetDevices = p2ph.Install(pgw, remoteHost);
97  Ipv4AddressHelper ipv4h;
98  ipv4h.SetBase("1.0.0.0", "255.0.0.0");
99  Ipv4InterfaceContainer internetIpIfaces = ipv4h.Assign(internetDevices);
100  // interface 0 is localhost, 1 is the p2p device
101  Ipv4Address remoteHostAddr = internetIpIfaces.GetAddress(1);
102 
103  Ipv4StaticRoutingHelper ipv4RoutingHelper;
104  Ptr<Ipv4StaticRouting> remoteHostStaticRouting =
105  ipv4RoutingHelper.GetStaticRouting(remoteHost->GetObject<Ipv4>());
106  remoteHostStaticRouting->AddNetworkRouteTo(Ipv4Address("7.0.0.0"), Ipv4Mask("255.0.0.0"), 1);
107 
108  NodeContainer ueNodes;
109  NodeContainer enbNodes;
110  enbNodes.Create(numNodePairs);
111  ueNodes.Create(numNodePairs);
112 
113  // Install Mobility Model
114  Ptr<ListPositionAllocator> positionAlloc = CreateObject<ListPositionAllocator>();
115  for (uint16_t i = 0; i < numNodePairs; i++)
116  {
117  positionAlloc->Add(Vector(distance * i, 0, 0));
118  }
120  mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
121  mobility.SetPositionAllocator(positionAlloc);
122  mobility.Install(enbNodes);
123  mobility.Install(ueNodes);
124 
125  // Install LTE Devices to the nodes
126  NetDeviceContainer enbLteDevs = lteHelper->InstallEnbDevice(enbNodes);
127  NetDeviceContainer ueLteDevs = lteHelper->InstallUeDevice(ueNodes);
128 
129  // Install the IP stack on the UEs
130  internet.Install(ueNodes);
131  Ipv4InterfaceContainer ueIpIface;
132  ueIpIface = epcHelper->AssignUeIpv4Address(NetDeviceContainer(ueLteDevs));
133  // Assign IP address to UEs, and install applications
134  for (uint32_t u = 0; u < ueNodes.GetN(); ++u)
135  {
136  Ptr<Node> ueNode = ueNodes.Get(u);
137  // Set the default gateway for the UE
138  Ptr<Ipv4StaticRouting> ueStaticRouting =
139  ipv4RoutingHelper.GetStaticRouting(ueNode->GetObject<Ipv4>());
140  ueStaticRouting->SetDefaultRoute(epcHelper->GetUeDefaultGatewayAddress(), 1);
141  }
142 
143  // Attach one UE per eNodeB
144  for (uint16_t i = 0; i < numNodePairs; i++)
145  {
146  lteHelper->Attach(ueLteDevs.Get(i), enbLteDevs.Get(i));
147  // side effect: the default EPS bearer will be activated
148  }
149 
150  // Install and start applications on UEs and remote host
151  uint16_t dlPort = 1100;
152  uint16_t ulPort = 2000;
153  uint16_t otherPort = 3000;
156  for (uint32_t u = 0; u < ueNodes.GetN(); ++u)
157  {
158  if (!disableDl)
159  {
160  PacketSinkHelper dlPacketSinkHelper("ns3::UdpSocketFactory",
162  serverApps.Add(dlPacketSinkHelper.Install(ueNodes.Get(u)));
163 
164  UdpClientHelper dlClient(ueIpIface.GetAddress(u), dlPort);
165  dlClient.SetAttribute("Interval", TimeValue(interPacketInterval));
166  dlClient.SetAttribute("MaxPackets", UintegerValue(1000000));
167  clientApps.Add(dlClient.Install(remoteHost));
168  }
169 
170  if (!disableUl)
171  {
172  ++ulPort;
173  PacketSinkHelper ulPacketSinkHelper("ns3::UdpSocketFactory",
175  serverApps.Add(ulPacketSinkHelper.Install(remoteHost));
176 
177  UdpClientHelper ulClient(remoteHostAddr, ulPort);
178  ulClient.SetAttribute("Interval", TimeValue(interPacketInterval));
179  ulClient.SetAttribute("MaxPackets", UintegerValue(1000000));
180  clientApps.Add(ulClient.Install(ueNodes.Get(u)));
181  }
182 
183  if (!disablePl && numNodePairs > 1)
184  {
185  ++otherPort;
186  PacketSinkHelper packetSinkHelper("ns3::UdpSocketFactory",
187  InetSocketAddress(Ipv4Address::GetAny(), otherPort));
188  serverApps.Add(packetSinkHelper.Install(ueNodes.Get(u)));
189 
190  UdpClientHelper client(ueIpIface.GetAddress(u), otherPort);
191  client.SetAttribute("Interval", TimeValue(interPacketInterval));
192  client.SetAttribute("MaxPackets", UintegerValue(1000000));
193  clientApps.Add(client.Install(ueNodes.Get((u + 1) % numNodePairs)));
194  }
195  }
196 
197  serverApps.Start(MilliSeconds(500));
198  clientApps.Start(MilliSeconds(500));
199  lteHelper->EnableTraces();
200  // Uncomment to enable PCAP tracing
201  // p2ph.EnablePcapAll("lena-simple-epc");
202 
203  Simulator::Stop(simTime);
204  Simulator::Run();
205 
206  /*GtkConfigStore config;
207  config.ConfigureAttributes();*/
208 
210  return 0;
211 }
holds a vector of ns3::Application pointers.
AttributeValue implementation for Boolean.
Definition: boolean.h:37
Parse command-line arguments.
Definition: command-line.h:232
Introspection did not find any typical Config paths.
Definition: config-store.h:61
void ConfigureDefaults()
Configure the default values.
AttributeValue implementation for DataRate.
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.
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:43
static Ipv4Address GetAny()
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
a class to represent an Ipv4 address mask
Definition: ipv4-address.h:258
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:282
NetDeviceContainer InstallEnbDevice(NodeContainer c)
Create a set of eNodeB devices.
Definition: lte-helper.cc:482
void EnableTraces()
Enables trace sinks for PHY, MAC, RLC and PDCP.
Definition: lte-helper.cc:1554
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
NetDeviceContainer InstallUeDevice(NodeContainer c)
Create a set of UE devices.
Definition: lte-helper.cc:497
Helper class used to assign positions and mobility models to nodes.
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.
Ptr< Node > GetPgwNode() const override
Get the PGW node.
Ipv4Address GetUeDefaultGatewayAddress() override
Ipv4InterfaceContainer AssignUeIpv4Address(NetDeviceContainer ueDevices) override
Assign IPv4 addresses to UE devices.
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:140
static void Run()
Run the simulation.
Definition: simulator.cc:176
static void Stop()
Tell the Simulator the calling event should be the last one executed.
Definition: simulator.cc:184
Hold variables of type string.
Definition: string.h:56
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:105
AttributeValue implementation for Time.
Definition: nstime.h:1423
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
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
void(* DataRate)(DataRate oldValue, DataRate newValue)
TracedValue callback signature for DataRate.
Definition: data-rate.h:328
Time MilliSeconds(uint64_t value)
Construct a Time in the indicated unit.
Definition: nstime.h:1348
serverApps
Definition: first.py:48
clientApps
Definition: first.py:58
Every class exported by the ns3 library is enclosed in the ns3 namespace.
cmd
Definition: second.py:33
mobility
Definition: third.py:96