A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
lena-simple-epc-emu.cc
Go to the documentation of this file.
1 /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2011, 2013 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: Jaume Nin <jaume.nin@cttc.cat>
19  * Nicola Baldo <nbaldo@cttc.cat>
20  */
21 
22 #include "ns3/lte-helper.h"
23 #include "ns3/epc-helper.h"
24 #include "ns3/core-module.h"
25 #include "ns3/network-module.h"
26 #include "ns3/ipv4-global-routing-helper.h"
27 #include "ns3/internet-module.h"
28 #include "ns3/mobility-module.h"
29 #include "ns3/lte-module.h"
30 #include "ns3/applications-module.h"
31 #include "ns3/point-to-point-helper.h"
32 #include <ns3/config-store-module.h>
33 
34 using namespace ns3;
35 
36 /*
37  * Simple simulation program using the emulated EPC.
38  * For the LTE radio part, it simulates a simple linear topology with
39  * a fixed number of eNBs spaced at equal distance, and a fixed number
40  * of UEs per each eNB, located at the same position of the eNB.
41  * For the EPC, it uses EmuEpcHelper to realize the S1-U connection
42  * via a real link.
43  */
44 
45 
46 
47 
48 NS_LOG_COMPONENT_DEFINE ("EpcFirstExample");
49 int
50 main (int argc, char *argv[])
51 {
52 
53  uint16_t nEnbs = 1;
54  uint16_t nUesPerEnb = 1;
55  double simTime = 10.1;
56  double distance = 1000.0;
57  double interPacketInterval = 1000;
58 
59  // Command line arguments
60  CommandLine cmd;
61  cmd.AddValue("nEnbs", "Number of eNBs", nEnbs);
62  cmd.AddValue("nUesPerEnb", "Number of UEs per eNB", nUesPerEnb);
63  cmd.AddValue("simTime", "Total duration of the simulation [s])", simTime);
64  cmd.AddValue("distance", "Distance between eNBs [m]", distance);
65  cmd.AddValue("interPacketInterval", "Inter packet interval [ms])", interPacketInterval);
66  cmd.Parse(argc, argv);
67 
68  // let's go in real time
69  // NOTE: if you go in real time I strongly advise to use
70  // --ns3::RealtimeSimulatorImpl::SynchronizationMode=HardLimit
71  // I've seen that if BestEffort is used things can break
72  // (even simple stuff such as ARP)
73  //GlobalValue::Bind ("SimulatorImplementationType",
74  // StringValue ("ns3::RealtimeSimulatorImpl"));
75 
76  // let's speed things up, we don't need these details for this scenario
77  Config::SetDefault ("ns3::LteSpectrumPhy::CtrlErrorModelEnabled", BooleanValue (false));
78  Config::SetDefault ("ns3::LteSpectrumPhy::DataErrorModelEnabled", BooleanValue (false));
79 
80  GlobalValue::Bind ("ChecksumEnabled", BooleanValue (true));
81 
82  ConfigStore inputConfig;
83  inputConfig.ConfigureDefaults();
84 
85  // parse again so you can override default values from the command line
86  cmd.Parse(argc, argv);
87 
88 
89 
90  Ptr<LteHelper> lteHelper = CreateObject<LteHelper> ();
91  Ptr<EmuEpcHelper> epcHelper = CreateObject<EmuEpcHelper> ();
92  lteHelper->SetEpcHelper (epcHelper);
93  epcHelper->Initialize ();
94 
95  Ptr<Node> pgw = epcHelper->GetPgwNode ();
96 
97  // Create a single RemoteHost
98  NodeContainer remoteHostContainer;
99  remoteHostContainer.Create (1);
100  Ptr<Node> remoteHost = remoteHostContainer.Get (0);
101  InternetStackHelper internet;
102  internet.Install (remoteHostContainer);
103 
104  // Create the Internet
105  PointToPointHelper p2ph;
106  p2ph.SetDeviceAttribute ("DataRate", DataRateValue (DataRate ("100Gb/s")));
107  p2ph.SetDeviceAttribute ("Mtu", UintegerValue (1500));
108  p2ph.SetChannelAttribute ("Delay", TimeValue (Seconds (0.010)));
109  NetDeviceContainer internetDevices = p2ph.Install (pgw, remoteHost);
110  Ipv4AddressHelper ipv4h;
111  ipv4h.SetBase ("1.0.0.0", "255.0.0.0");
112  Ipv4InterfaceContainer internetIpIfaces = ipv4h.Assign (internetDevices);
113  // interface 0 is localhost, 1 is the p2p device
114  Ipv4Address remoteHostAddr = internetIpIfaces.GetAddress (1);
115 
116  Ipv4StaticRoutingHelper ipv4RoutingHelper;
117  Ptr<Ipv4StaticRouting> remoteHostStaticRouting = ipv4RoutingHelper.GetStaticRouting (remoteHost->GetObject<Ipv4> ());
118  remoteHostStaticRouting->AddNetworkRouteTo (Ipv4Address ("7.0.0.0"), Ipv4Mask ("255.0.0.0"), 1);
119 
120  NodeContainer ueNodes;
121  NodeContainer enbNodes;
122  enbNodes.Create(nEnbs);
123  ueNodes.Create(nEnbs*nUesPerEnb);
124 
125  // Install Mobility Model
126  Ptr<ListPositionAllocator> positionAlloc = CreateObject<ListPositionAllocator> ();
127  for (uint16_t i = 0; i < nEnbs; i++)
128  {
129  positionAlloc->Add (Vector(distance * i, 0, 0));
130  }
131  MobilityHelper mobility;
132  mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
133  mobility.SetPositionAllocator(positionAlloc);
134  mobility.Install(enbNodes);
135  mobility.Install(ueNodes);
136 
137  // Install LTE Devices to the nodes
138  NetDeviceContainer enbLteDevs = lteHelper->InstallEnbDevice (enbNodes);
139  NetDeviceContainer ueLteDevs = lteHelper->InstallUeDevice (ueNodes);
140 
141  // Install the IP stack on the UEs
142  internet.Install (ueNodes);
143  Ipv4InterfaceContainer ueIpIface;
144  ueIpIface = epcHelper->AssignUeIpv4Address (NetDeviceContainer (ueLteDevs));
145  // Assign IP address to UEs, and install applications
146  for (uint32_t u = 0; u < ueNodes.GetN (); ++u)
147  {
148  Ptr<Node> ueNode = ueNodes.Get (u);
149  // Set the default gateway for the UE
150  Ptr<Ipv4StaticRouting> ueStaticRouting = ipv4RoutingHelper.GetStaticRouting (ueNode->GetObject<Ipv4> ());
151  ueStaticRouting->SetDefaultRoute (epcHelper->GetUeDefaultGatewayAddress (), 1);
152  }
153 
154  lteHelper->Attach (ueLteDevs);
155  // side effects: 1) use idle mode cell selection, 2) activate default EPS bearer
156 
157  // randomize a bit start times to avoid simulation artifacts
158  // (e.g., buffer overflows due to packet transmissions happening
159  // exactly at the same time)
160  Ptr<UniformRandomVariable> startTimeSeconds = CreateObject<UniformRandomVariable> ();
161  startTimeSeconds->SetAttribute ("Min", DoubleValue (0));
162  startTimeSeconds->SetAttribute ("Max", DoubleValue (interPacketInterval/1000.0));
163 
164  // Install and start applications on UEs and remote host
165  uint16_t dlPort = 1234;
166  uint16_t ulPort = 2000;
167  for (uint32_t u = 0; u < ueNodes.GetN (); ++u)
168  {
169  ++ulPort;
172 
173 
174  PacketSinkHelper dlPacketSinkHelper ("ns3::UdpSocketFactory", InetSocketAddress (Ipv4Address::GetAny (), dlPort));
175  PacketSinkHelper ulPacketSinkHelper ("ns3::UdpSocketFactory", InetSocketAddress (Ipv4Address::GetAny (), ulPort));
176  serverApps.Add (dlPacketSinkHelper.Install (ueNodes.Get(u)));
177  serverApps.Add (ulPacketSinkHelper.Install (remoteHost));
178 
179  UdpClientHelper dlClient (ueIpIface.GetAddress (u), dlPort);
180  dlClient.SetAttribute ("Interval", TimeValue (MilliSeconds(interPacketInterval)));
181  dlClient.SetAttribute ("MaxPackets", UintegerValue(1000000));
182 
183  UdpClientHelper ulClient (remoteHostAddr, ulPort);
184  ulClient.SetAttribute ("Interval", TimeValue (MilliSeconds(interPacketInterval)));
185  ulClient.SetAttribute ("MaxPackets", UintegerValue(1000000));
186 
187  clientApps.Add (dlClient.Install (remoteHost));
188  clientApps.Add (ulClient.Install (ueNodes.Get(u)));
189 
190  serverApps.Start (Seconds (startTimeSeconds->GetValue ()));
191  clientApps.Start (Seconds (startTimeSeconds->GetValue ()));
192  }
193 
194  Simulator::Stop(Seconds(simTime));
195  Simulator::Run();
196 
198  return 0;
199 }
200 
holds a vector of ns3::Application pointers.
Doxygen introspection did not find any typical Config paths.
Definition: config-store.h:34
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:382
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.
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:709
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:170
Time MilliSeconds(uint64_t value)
Construct a Time in the indicated unit.
Definition: nstime.h:853
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 SetDeviceAttribute(std::string name, const AttributeValue &value)
Set an attribute value to be propagated to each NetDevice created by the helper.
ApplicationContainer Install(NodeContainer c)
tuple clientApps
Definition: first.py:53
uint32_t GetN(void) const
Get the number of Ptr stored in this container.
Class for representing data rates.
Definition: data-rate.h:71
int main(int argc, char *argv[])
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...
Attribute for objects of type ns3::Time.
Definition: nstime.h:912
Hold an unsigned integer type.
Definition: uinteger.h:46
holds a vector of ns3::NetDevice pointers
Vector3D Vector
Definition: vector.h:118
static void Bind(std::string name, const AttributeValue &value)
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:196
static void Destroy(void)
Every event scheduled by the Simulator::insertAtDestroy method is invoked.
Definition: simulator.cc:121
tuple serverApps
Definition: first.py:44
void ConfigureDefaults(void)
Access to the Ipv4 forwarding table, interfaces, and configuration.
Definition: ipv4.h:76
void SetAttribute(std::string name, const AttributeValue &value)
Record an attribute to be set in each Application after it is is created.
void SetDefault(std::string name, const AttributeValue &value)
Definition: config.cc:677
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 SetChannelAttribute(std::string name, const AttributeValue &value)
Set an attribute value to be propagated to each Channel created by the helper.
NetDeviceContainer InstallUeDevice(NodeContainer c)
create a set of UE devices
Definition: lte-helper.cc:397
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:218
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:471
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.
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:845
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 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
void SetBase(Ipv4Address network, Ipv4Mask mask, Ipv4Address base="0.0.0.1")
Set the base network number, network mask and base address.
Ipv4Address GetAddress(uint32_t i, uint32_t j=0) const