A Discrete-Event Network Simulator
API
emu-epc-helper.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011-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  * Authors:
18  * Jaume Nin <jnin@cttc.es>
19  * Nicola Baldo <nbaldo@cttc.es>
20  * Manuel Requena <manuel.requena@cttc.es>
21  */
22 
23 #include "emu-epc-helper.h"
24 
25 #include "ns3/emu-fd-net-device-helper.h"
26 #include "ns3/epc-x2.h"
27 #include "ns3/log.h"
28 #include "ns3/lte-enb-net-device.h"
29 #include "ns3/lte-enb-rrc.h"
30 #include "ns3/string.h"
31 
32 #include <iomanip>
33 
34 namespace ns3
35 {
36 
37 NS_LOG_COMPONENT_DEFINE("EmuEpcHelper");
38 
39 NS_OBJECT_ENSURE_REGISTERED(EmuEpcHelper);
40 
43 {
44  NS_LOG_FUNCTION(this);
45  // To access the attribute value within the constructor
47 
48  // Create EmuFdNetDevice for SGW
50  NS_LOG_LOGIC("SGW device: " << m_sgwDeviceName);
52 
53  Ptr<Node> sgw = GetSgwNode();
54  NetDeviceContainer sgwDevices = emu.Install(sgw);
55  Ptr<NetDevice> sgwDevice = sgwDevices.Get(0);
56  NS_LOG_LOGIC("SGW MAC address: " << m_sgwMacAddress);
57  sgwDevice->SetAttribute("Address", Mac48AddressValue(m_sgwMacAddress.c_str()));
58 
59  // Address of the SGW: 10.0.0.1
60  m_epcIpv4AddressHelper.SetBase("10.0.0.0", "255.255.255.0", "0.0.0.1");
62 
63  // Address of the first eNB: 10.0.0.101
64  m_epcIpv4AddressHelper.SetBase("10.0.0.0", "255.255.255.0", "0.0.0.101");
65 }
66 
68 {
69  NS_LOG_FUNCTION(this);
70 }
71 
72 TypeId
74 {
75  static TypeId tid =
76  TypeId("ns3::EmuEpcHelper")
78  .SetGroupName("Lte")
79  .AddConstructor<EmuEpcHelper>()
80  .AddAttribute("SgwDeviceName",
81  "The name of the device used for the S1-U interface of the SGW",
82  StringValue("veth0"),
85  .AddAttribute("EnbDeviceName",
86  "The name of the device used for the S1-U interface of the eNB",
87  StringValue("veth1"),
90  .AddAttribute("SgwMacAddress",
91  "MAC address used for the SGW",
92  StringValue("00:00:00:59:00:aa"),
95  .AddAttribute("EnbMacAddressBase",
96  "First 5 bytes of the eNB MAC address base",
97  StringValue("00:00:00:eb:00"),
100  return tid;
101 }
102 
103 TypeId
105 {
106  return GetTypeId();
107 }
108 
109 void
111 {
112  NS_LOG_FUNCTION(this);
114 }
115 
116 void
117 EmuEpcHelper::AddEnb(Ptr<Node> enb, Ptr<NetDevice> lteEnbNetDevice, std::vector<uint16_t> cellIds)
118 {
119  NS_LOG_FUNCTION(this << enb << lteEnbNetDevice << cellIds.size());
120 
121  NoBackhaulEpcHelper::AddEnb(enb, lteEnbNetDevice, cellIds);
122 
123  // Create an EmuFdNetDevice for the eNB to connect with the SGW and other eNBs
125  NS_LOG_LOGIC("eNB cellId: " << cellIds.at(0));
126  NS_LOG_LOGIC("eNB device: " << m_enbDeviceName);
128  NetDeviceContainer enbDevices = emu.Install(enb);
129 
130  std::ostringstream enbMacAddress;
131  enbMacAddress << m_enbMacAddressBase << ":" << std::hex << std::setfill('0') << std::setw(2)
132  << cellIds.at(0);
133  NS_LOG_LOGIC("eNB MAC address: " << enbMacAddress.str());
134  Ptr<NetDevice> enbDev = enbDevices.Get(0);
135  enbDev->SetAttribute("Address", Mac48AddressValue(enbMacAddress.str().c_str()));
136 
137  // emu.EnablePcap ("enbDevice", enbDev);
138 
139  NS_LOG_LOGIC("number of Ipv4 ifaces of the eNB after installing emu dev: "
140  << enb->GetObject<Ipv4>()->GetNInterfaces());
141  Ipv4InterfaceContainer enbIpIfaces = m_epcIpv4AddressHelper.Assign(enbDevices);
142  NS_LOG_LOGIC("number of Ipv4 ifaces of the eNB after assigning Ipv4 addr to S1 dev: "
143  << enb->GetObject<Ipv4>()->GetNInterfaces());
144 
145  Ipv4Address enbAddress = enbIpIfaces.GetAddress(0);
146  Ipv4Address sgwAddress = m_sgwIpIfaces.GetAddress(0);
147 
148  NoBackhaulEpcHelper::AddS1Interface(enb, enbAddress, sgwAddress, cellIds);
149 }
150 
151 void
153 {
154  NS_LOG_FUNCTION(this << enb1 << enb2);
155 
156  NS_LOG_WARN("X2 support still untested");
157 
158  // for X2, we reuse the same device and IP address of the S1-U interface
159  Ptr<Ipv4> enb1Ipv4 = enb1->GetObject<Ipv4>();
160  Ptr<Ipv4> enb2Ipv4 = enb2->GetObject<Ipv4>();
161  NS_LOG_LOGIC("number of Ipv4 ifaces of the eNB #1: " << enb1Ipv4->GetNInterfaces());
162  NS_LOG_LOGIC("number of Ipv4 ifaces of the eNB #2: " << enb2Ipv4->GetNInterfaces());
163  NS_LOG_LOGIC("number of NetDevices of the eNB #1: " << enb1->GetNDevices());
164  NS_LOG_LOGIC("number of NetDevices of the eNB #2: " << enb2->GetNDevices());
165 
166  // 0 is the LTE device, 1 is localhost, 2 is the EPC NetDevice
167  Ptr<NetDevice> enb1EpcDev = enb1->GetDevice(2);
168  Ptr<NetDevice> enb2EpcDev = enb2->GetDevice(2);
169 
170  int32_t enb1Interface = enb1Ipv4->GetInterfaceForDevice(enb1EpcDev);
171  int32_t enb2Interface = enb2Ipv4->GetInterfaceForDevice(enb2EpcDev);
172  NS_ASSERT(enb1Interface >= 0);
173  NS_ASSERT(enb2Interface >= 0);
174  NS_ASSERT(enb1Ipv4->GetNAddresses(enb1Interface) == 1);
175  NS_ASSERT(enb2Ipv4->GetNAddresses(enb2Interface) == 1);
176  Ipv4Address enb1Addr = enb1Ipv4->GetAddress(enb1Interface, 0).GetLocal();
177  Ipv4Address enb2Addr = enb2Ipv4->GetAddress(enb2Interface, 0).GetLocal();
178  NS_LOG_LOGIC(" eNB 1 IP address: " << enb1Addr);
179  NS_LOG_LOGIC(" eNB 2 IP address: " << enb2Addr);
180 
181  // Add X2 interface to both eNBs' X2 entities
182  Ptr<EpcX2> enb1X2 = enb1->GetObject<EpcX2>();
183  Ptr<LteEnbNetDevice> enb1LteDev = enb1->GetDevice(0)->GetObject<LteEnbNetDevice>();
184  std::vector<uint16_t> enb1CellIds = enb1LteDev->GetCellIds();
185  uint16_t enb1CellId = enb1CellIds.at(0);
186  NS_LOG_LOGIC("LteEnbNetDevice #1 = " << enb1LteDev << " - CellId = " << enb1CellId);
187 
188  Ptr<EpcX2> enb2X2 = enb2->GetObject<EpcX2>();
189  Ptr<LteEnbNetDevice> enb2LteDev = enb2->GetDevice(0)->GetObject<LteEnbNetDevice>();
190  std::vector<uint16_t> enb2CellIds = enb2LteDev->GetCellIds();
191  uint16_t enb2CellId = enb2CellIds.at(0);
192  NS_LOG_LOGIC("LteEnbNetDevice #2 = " << enb2LteDev << " - CellId = " << enb2CellId);
193 
194  enb1X2->AddX2Interface(enb1CellId, enb1Addr, enb2CellIds, enb2Addr);
195  enb2X2->AddX2Interface(enb2CellId, enb2Addr, enb1CellIds, enb1Addr);
196 
197  enb1LteDev->GetRrc()->AddX2Neighbour(enb2LteDev->GetCellId());
198  enb2LteDev->GetRrc()->AddX2Neighbour(enb1LteDev->GetCellId());
199 }
200 
201 } // namespace ns3
List of Attribute name, value and checker triples used to construct Objects.
Create an EPC network using EmuFdNetDevice.
TypeId GetInstanceTypeId() const override
Get the most derived TypeId for this Object.
EmuEpcHelper()
Constructor.
static TypeId GetTypeId()
Register this type.
~EmuEpcHelper() override
Destructor.
Ipv4AddressHelper m_epcIpv4AddressHelper
helper to assign addresses to S1-U NetDevices
std::string m_enbMacAddressBase
First 5 bytes of the Enb MAC address base.
void DoDispose() override
Destructor implementation.
std::string m_enbDeviceName
The name of the device used for the S1-U interface of the eNB.
std::string m_sgwDeviceName
The name of the device used for the S1-U interface of the SGW.
std::string m_sgwMacAddress
MAC address used for the SGW.
void AddX2Interface(Ptr< Node > enbNode1, Ptr< Node > enbNode2) override
Add an X2 interface between two eNB.
Ipv4InterfaceContainer m_sgwIpIfaces
Container for Ipv4Interfaces of the SGW.
void AddEnb(Ptr< Node > enbNode, Ptr< NetDevice > lteEnbNetDevice, std::vector< uint16_t > cellIds) override
Add an eNB to the EPC.
build a set of FdNetDevice objects attached to a physical network interface
void SetDeviceName(std::string deviceName)
Set the device name of this device.
Base helper class to handle the creation of the EPC entities.
Definition: epc-helper.h:51
This entity is installed inside an eNB and provides the functionality for the X2 interface.
Definition: epc-x2.h:99
virtual NetDeviceContainer Install(Ptr< Node > node) const
This method creates a FdNetDevice and associates it to a node.
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:42
Access to the IPv4 forwarding table, interfaces, and configuration.
Definition: ipv4.h:80
virtual uint32_t GetNInterfaces() const =0
holds a vector of std::pair of Ptr<Ipv4> and interface index.
Ipv4Address GetAddress(uint32_t i, uint32_t j=0) const
The eNodeB device implementation.
std::vector< uint16_t > GetCellIds() const
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.
Create an EPC network with PointToPoint links between the core network nodes.
Ptr< Node > GetSgwNode() const override
Get the SGW node.
void DoDispose() override
Destructor implementation.
void AddS1Interface(Ptr< Node > enb, Ipv4Address enbAddress, Ipv4Address sgwAddress, std::vector< uint16_t > cellIds) override
Add an S1 interface between an eNB and a SGW.
void AddEnb(Ptr< Node > enbNode, Ptr< NetDevice > lteEnbNetDevice, std::vector< uint16_t > cellIds) override
Add an eNB to the EPC.
uint32_t GetNDevices() const
Definition: node.cc:162
Ptr< NetDevice > GetDevice(uint32_t index) const
Retrieve the index-th NetDevice associated to this node.
Definition: node.cc:152
void ConstructSelf(const AttributeConstructionList &attributes)
Complete construction of ObjectBase; invoked by derived classes.
Definition: object-base.cc:85
Ptr< T > GetObject() const
Get a pointer to the requested aggregated Object.
Definition: object.h:471
Hold variables of type string.
Definition: string.h:56
a unique identifier for an interface.
Definition: type-id.h:59
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:931
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file,...
Definition: assert.h:66
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
#define NS_LOG_LOGIC(msg)
Use NS_LOG to output a message of level LOG_LOGIC.
Definition: log.h:282
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
#define NS_LOG_WARN(msg)
Use NS_LOG to output a message of level LOG_WARN.
Definition: log.h:261
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:46
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Ptr< const AttributeChecker > MakeStringChecker()
Definition: string.cc:30
Ptr< const AttributeAccessor > MakeStringAccessor(T1 a1)
Definition: string.h:57