A Discrete-Event Network Simulator
Go to the documentation of this file.
1 /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2011 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
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  */
21 #include "ns3/lte-helper.h"
22 #include "ns3/epc-helper.h"
23 #include "ns3/core-module.h"
24 #include "ns3/network-module.h"
25 #include "ns3/ipv4-global-routing-helper.h"
26 #include "ns3/internet-module.h"
27 #include "ns3/mobility-module.h"
28 #include "ns3/lte-module.h"
29 #include "ns3/applications-module.h"
30 #include "ns3/point-to-point-helper.h"
31 #include "ns3/config-store.h"
32 //#include "ns3/gtk-config-store.h"
34 using namespace ns3;
42 NS_LOG_COMPONENT_DEFINE ("EpcFirstExample");
44 int
45 main (int argc, char *argv[])
46 {
48  uint16_t numberOfNodes = 2;
49  double simTime = 1.1;
50  double distance = 60.0;
51  double interPacketInterval = 100;
52  bool useCa = false;
54  // Command line arguments
56  cmd.AddValue("numberOfNodes", "Number of eNodeBs + UE pairs", numberOfNodes);
57  cmd.AddValue("simTime", "Total duration of the simulation [s])", simTime);
58  cmd.AddValue("distance", "Distance between eNBs [m]", distance);
59  cmd.AddValue("interPacketInterval", "Inter packet interval [ms])", interPacketInterval);
60  cmd.AddValue("useCa", "Whether to use carrier aggregation.", useCa);
61  cmd.Parse(argc, argv);
63  if (useCa)
64  {
65  Config::SetDefault ("ns3::LteHelper::UseCa", BooleanValue (useCa));
66  Config::SetDefault ("ns3::LteHelper::NumberOfComponentCarriers", UintegerValue (2));
67  Config::SetDefault ("ns3::LteHelper::EnbComponentCarrierManager", StringValue ("ns3::RrComponentCarrierManager"));
68  }
70  Ptr<LteHelper> lteHelper = CreateObject<LteHelper> ();
71  Ptr<PointToPointEpcHelper> epcHelper = CreateObject<PointToPointEpcHelper> ();
72  lteHelper->SetEpcHelper (epcHelper);
74  ConfigStore inputConfig;
75  inputConfig.ConfigureDefaults();
77  // parse again so you can override default values from the command line
78  cmd.Parse(argc, argv);
80  Ptr<Node> pgw = epcHelper->GetPgwNode ();
82  // Create a single RemoteHost
83  NodeContainer remoteHostContainer;
84  remoteHostContainer.Create (1);
85  Ptr<Node> remoteHost = remoteHostContainer.Get (0);
86  InternetStackHelper internet;
87  internet.Install (remoteHostContainer);
89  // Create the Internet
90  PointToPointHelper p2ph;
91  p2ph.SetDeviceAttribute ("DataRate", DataRateValue (DataRate ("100Gb/s")));
92  p2ph.SetDeviceAttribute ("Mtu", UintegerValue (1500));
93  p2ph.SetChannelAttribute ("Delay", TimeValue (Seconds (0.010)));
94  NetDeviceContainer internetDevices = p2ph.Install (pgw, remoteHost);
95  Ipv4AddressHelper ipv4h;
96  ipv4h.SetBase ("", "");
97  Ipv4InterfaceContainer internetIpIfaces = ipv4h.Assign (internetDevices);
98  // interface 0 is localhost, 1 is the p2p device
99  Ipv4Address remoteHostAddr = internetIpIfaces.GetAddress (1);
101  Ipv4StaticRoutingHelper ipv4RoutingHelper;
102  Ptr<Ipv4StaticRouting> remoteHostStaticRouting = ipv4RoutingHelper.GetStaticRouting (remoteHost->GetObject<Ipv4> ());
103  remoteHostStaticRouting->AddNetworkRouteTo (Ipv4Address (""), Ipv4Mask (""), 1);
105  NodeContainer ueNodes;
106  NodeContainer enbNodes;
107  enbNodes.Create(numberOfNodes);
108  ueNodes.Create(numberOfNodes);
110  // Install Mobility Model
111  Ptr<ListPositionAllocator> positionAlloc = CreateObject<ListPositionAllocator> ();
112  for (uint16_t i = 0; i < numberOfNodes; i++)
113  {
114  positionAlloc->Add (Vector(distance * i, 0, 0));
115  }
117  mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
118  mobility.SetPositionAllocator(positionAlloc);
119  mobility.Install(enbNodes);
120  mobility.Install(ueNodes);
122  // Install LTE Devices to the nodes
123  NetDeviceContainer enbLteDevs = lteHelper->InstallEnbDevice (enbNodes);
124  NetDeviceContainer ueLteDevs = lteHelper->InstallUeDevice (ueNodes);
126  // Install the IP stack on the UEs
127  internet.Install (ueNodes);
128  Ipv4InterfaceContainer ueIpIface;
129  ueIpIface = epcHelper->AssignUeIpv4Address (NetDeviceContainer (ueLteDevs));
130  // Assign IP address to UEs, and install applications
131  for (uint32_t u = 0; u < ueNodes.GetN (); ++u)
132  {
133  Ptr<Node> ueNode = ueNodes.Get (u);
134  // Set the default gateway for the UE
135  Ptr<Ipv4StaticRouting> ueStaticRouting = ipv4RoutingHelper.GetStaticRouting (ueNode->GetObject<Ipv4> ());
136  ueStaticRouting->SetDefaultRoute (epcHelper->GetUeDefaultGatewayAddress (), 1);
137  }
139  // Attach one UE per eNodeB
140  for (uint16_t i = 0; i < numberOfNodes; i++)
141  {
142  lteHelper->Attach (ueLteDevs.Get(i), enbLteDevs.Get(i));
143  // side effect: the default EPS bearer will be activated
144  }
147  // Install and start applications on UEs and remote host
148  uint16_t dlPort = 1234;
149  uint16_t ulPort = 2000;
150  uint16_t otherPort = 3000;
153  for (uint32_t u = 0; u < ueNodes.GetN (); ++u)
154  {
155  ++ulPort;
156  ++otherPort;
157  PacketSinkHelper dlPacketSinkHelper ("ns3::UdpSocketFactory", InetSocketAddress (Ipv4Address::GetAny (), dlPort));
158  PacketSinkHelper ulPacketSinkHelper ("ns3::UdpSocketFactory", InetSocketAddress (Ipv4Address::GetAny (), ulPort));
159  PacketSinkHelper packetSinkHelper ("ns3::UdpSocketFactory", InetSocketAddress (Ipv4Address::GetAny (), otherPort));
160  serverApps.Add (dlPacketSinkHelper.Install (ueNodes.Get(u)));
161  serverApps.Add (ulPacketSinkHelper.Install (remoteHost));
162  serverApps.Add (packetSinkHelper.Install (ueNodes.Get(u)));
164  UdpClientHelper dlClient (ueIpIface.GetAddress (u), dlPort);
165  dlClient.SetAttribute ("Interval", TimeValue (MilliSeconds(interPacketInterval)));
166  dlClient.SetAttribute ("MaxPackets", UintegerValue(1000000));
168  UdpClientHelper ulClient (remoteHostAddr, ulPort);
169  ulClient.SetAttribute ("Interval", TimeValue (MilliSeconds(interPacketInterval)));
170  ulClient.SetAttribute ("MaxPackets", UintegerValue(1000000));
172  UdpClientHelper client (ueIpIface.GetAddress (u), otherPort);
173  client.SetAttribute ("Interval", TimeValue (MilliSeconds(interPacketInterval)));
174  client.SetAttribute ("MaxPackets", UintegerValue(1000000));
176  clientApps.Add (dlClient.Install (remoteHost));
177  clientApps.Add (ulClient.Install (ueNodes.Get(u)));
178  if (u+1 < ueNodes.GetN ())
179  {
180  clientApps.Add (client.Install (ueNodes.Get(u+1)));
181  }
182  else
183  {
184  clientApps.Add (client.Install (ueNodes.Get(0)));
185  }
186  }
187  serverApps.Start (Seconds (0.01));
188  clientApps.Start (Seconds (0.01));
189  lteHelper->EnableTraces ();
190  // Uncomment to enable PCAP tracing
191  //p2ph.EnablePcapAll("lena-epc-first");
193  Simulator::Stop(Seconds(simTime));
194  Simulator::Run();
196  /*GtkConfigStore config;
197  config.ConfigureAttributes();*/
200  return 0;
202 }
holds a vector of ns3::Application pointers.
Introspection did not find any typical Config paths.
Definition: config-store.h:59
an Inet address class
static Ipv4Address GetAny(void)
AttributeValue implementation for Boolean.
Definition: boolean.h:36
NetDeviceContainer InstallEnbDevice(NodeContainer c)
Create a set of eNodeB devices.
Definition: lte-helper.cc:484
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.
Ptr< T > GetObject(void) const
Get a pointer to the requested aggregated Object.
Definition: object.h:459
Hold variables of type string.
Definition: string.h:41
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:258
void Add(ApplicationContainer other)
Append the contents of another ApplicationContainer to the end of this container. ...
static void Run(void)
Run the simulation.
Definition: simulator.cc:226
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:943
Define a Log component with a specific name.
Definition: log.h:201
Time MilliSeconds(uint64_t value)
Construct a Time in the indicated unit.
Definition: nstime.h:1001
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.
tuple cmd
Definition: second.py:35
tuple clientApps
Definition: first.py:54
uint32_t GetN(void) const
Get the number of Ptr stored in this container.
Class for representing data rates.
Definition: data-rate.h:88
void Install(Ptr< Node > node) const
"Layout" a single node according to the current position allocator type.
tuple mobility
Definition: third.py:101
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:1055
void EnableTraces(void)
Enables trace sinks for PHY, MAC, RLC and PDCP.
Definition: lte-helper.cc:1341
Hold an unsigned integer type.
Definition: uinteger.h:44
holds a vector of ns3::NetDevice pointers
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:205
static void Destroy(void)
Execute the events scheduled with ScheduleDestroy().
Definition: simulator.cc:190
tuple serverApps
Definition: first.py:45
void ConfigureDefaults(void)
Configure the default values.
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.
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 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:499
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:40
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:275
Helper class that adds ns3::Ipv4StaticRouting objects.
AttributeValue implementation for DataRate.
Definition: data-rate.h:242
void AddValue(const std::string &name, const std::string &help, T &value)
Add a program argument, assigning to POD.
Definition: command-line.h:498
static void Stop(void)
Tell the Simulator the calling event should be the last one executed.
Definition: simulator.cc:234
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:993
void SetDefault(std::string name, const AttributeValue &value)
Definition: config.cc:782
void Add(Vector v)
Add a position to the list of positions.
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...
void SetBase(Ipv4Address network, Ipv4Mask mask, Ipv4Address base="")
Set the base network number, network mask and base address.
Ipv4Address GetAddress(uint32_t i, uint32_t j=0) const