A Discrete-Event Network Simulator
API
no-backhaul-epc-helper.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 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  * Author: Manuel Requena <manuel.requena@cttc.es>
18  * (based on the original point-to-point-epc-helper.h)
19  */
20 
21 #ifndef NO_BACKHAUL_EPC_HELPER_H
22 #define NO_BACKHAUL_EPC_HELPER_H
23 
24 #include "epc-helper.h"
25 
26 namespace ns3
27 {
28 
29 class EpcSgwApplication;
30 class EpcPgwApplication;
31 class EpcMmeApplication;
32 
47 {
48  public:
53 
57  ~NoBackhaulEpcHelper() override;
58 
59  // inherited from Object
64  static TypeId GetTypeId();
65  TypeId GetInstanceTypeId() const override;
66  void DoDispose() override;
67 
68  // inherited from EpcHelper
69  void AddEnb(Ptr<Node> enbNode,
70  Ptr<NetDevice> lteEnbNetDevice,
71  std::vector<uint16_t> cellIds) override;
72  void AddUe(Ptr<NetDevice> ueLteDevice, uint64_t imsi) override;
73  void AddX2Interface(Ptr<Node> enbNode1, Ptr<Node> enbNode2) override;
74  void AddS1Interface(Ptr<Node> enb,
75  Ipv4Address enbAddress,
76  Ipv4Address sgwAddress,
77  std::vector<uint16_t> cellIds) override;
78  uint8_t ActivateEpsBearer(Ptr<NetDevice> ueLteDevice,
79  uint64_t imsi,
80  Ptr<EpcTft> tft,
81  EpsBearer bearer) override;
82  Ptr<Node> GetSgwNode() const override;
83  Ptr<Node> GetPgwNode() const override;
88  int64_t AssignStreams(int64_t stream) override;
89 
90  protected:
101  virtual void DoAddX2Interface(const Ptr<EpcX2>& enb1X2,
102  const Ptr<NetDevice>& enb1LteDev,
103  const Ipv4Address& enb1X2Address,
104  const Ptr<EpcX2>& enb2X2,
105  const Ptr<NetDevice>& enb2LteDev,
106  const Ipv4Address& enb2X2Address) const;
107 
114  virtual void DoActivateEpsBearerForUe(const Ptr<NetDevice>& ueDevice,
115  const Ptr<EpcTft>& tft,
116  const EpsBearer& bearer) const;
117 
118  private:
127 
132 
137 
142 
147 
152 
157 
162 
166  uint16_t m_gtpuUdpPort;
167 
172 
177 
182 
186  uint16_t m_s11LinkMtu;
187 
191  uint16_t m_gtpcUdpPort;
192 
201 
206 
211 
215  uint16_t m_s5LinkMtu;
216 
220  std::map<uint64_t, Ptr<NetDevice>> m_imsiEnbDeviceMap;
221 
226 
231 
236 
241  uint16_t m_x2LinkMtu;
242 
247 
251  std::string m_x2LinkPcapPrefix;
252 };
253 
254 } // namespace ns3
255 
256 #endif // NO_BACKHAUL_EPC_HELPER_H
Class for representing data rates.
Definition: data-rate.h:89
Base helper class to handle the creation of the EPC entities.
Definition: epc-helper.h:51
This class contains the specification of EPS Bearers.
Definition: eps-bearer.h:91
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:42
holds a vector of std::pair of Ptr<Ipv4> and interface index.
Helper class to auto-assign global IPv6 unicast addresses.
Describes an IPv6 address.
Definition: ipv6-address.h:49
Keep track of a set of IPv6 interfaces.
holds a vector of ns3::NetDevice pointers
Create an EPC network with PointToPoint links between the core network nodes.
uint16_t m_s5LinkMtu
The MTU of the next S5 link to be created.
static TypeId GetTypeId()
Register this type.
Ptr< VirtualNetDevice > m_tunDevice
TUN device implementing tunneling of user data over GTP-U/UDP/IP.
Time m_s5LinkDelay
The delay to be used for the next S5 link to be created.
Ipv4AddressHelper m_x2Ipv4AddressHelper
helper to assign addresses to X2 NetDevices
Ptr< Node > m_sgw
SGW network element.
~NoBackhaulEpcHelper() override
Destructor.
Ptr< EpcSgwApplication > m_sgwApp
SGW application.
DataRate m_x2LinkDataRate
The data rate to be used for the next X2 link to be created.
Ptr< Node > m_mme
MME network element.
Ipv4AddressHelper m_uePgwAddressHelper
helper to assign IPv4 addresses to UE devices as well as to the TUN device of the SGW/PGW
Ptr< Node > GetSgwNode() const override
Get the SGW node.
Ptr< EpcMmeApplication > m_mmeApp
MME application.
void AddUe(Ptr< NetDevice > ueLteDevice, uint64_t imsi) override
Notify the EPC of the existence of a new UE which might attach at a later time.
TypeId GetInstanceTypeId() const override
Get the most derived TypeId for this Object.
uint16_t m_s11LinkMtu
The MTU of the next S11 link to be created.
std::string m_x2LinkPcapPrefix
Prefix for the PCAP file for the X2 link.
bool m_x2LinkEnablePcap
Enable PCAP generation for X2 link.
Ipv6Address GetUeDefaultGatewayAddress6() override
uint8_t ActivateEpsBearer(Ptr< NetDevice > ueLteDevice, uint64_t imsi, Ptr< EpcTft > tft, EpsBearer bearer) override
Activate an EPS bearer, setting up the corresponding S1-U tunnel.
Ptr< Node > GetPgwNode() const override
Get the PGW node.
void DoDispose() override
Destructor implementation.
Ipv4AddressHelper m_s5Ipv4AddressHelper
S5 interfaces.
uint16_t m_x2LinkMtu
The MTU of the next X2 link to be created.
Ipv6InterfaceContainer AssignUeIpv6Address(NetDeviceContainer ueDevices) override
Assign IPv6 addresses to UE devices.
uint16_t m_gtpcUdpPort
UDP port where the GTPv2-C Socket is bound, fixed by the standard as 2123.
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 AddX2Interface(Ptr< Node > enbNode1, Ptr< Node > enbNode2) override
Add an X2 interface between two eNB.
Ptr< EpcPgwApplication > m_pgwApp
PGW application.
uint16_t m_gtpuUdpPort
UDP port where the GTP-U Socket is bound, fixed by the standard as 2152.
virtual void DoAddX2Interface(const Ptr< EpcX2 > &enb1X2, const Ptr< NetDevice > &enb1LteDev, const Ipv4Address &enb1X2Address, const Ptr< EpcX2 > &enb2X2, const Ptr< NetDevice > &enb2LteDev, const Ipv4Address &enb2X2Address) const
DoAddX2Interface: Call AddX2Interface on top of the Enb device pointers.
Time m_x2LinkDelay
The delay to be used for the next X2 link to be created.
Ipv4AddressHelper m_s11Ipv4AddressHelper
Helper to assign addresses to S11 NetDevices.
int64_t AssignStreams(int64_t stream) override
Assign a fixed random variable stream number to the random variables used.
Ipv4Address GetUeDefaultGatewayAddress() override
Ipv4InterfaceContainer AssignUeIpv4Address(NetDeviceContainer ueDevices) override
Assign IPv4 addresses to UE devices.
Time m_s11LinkDelay
The delay to be used for the next S11 link to be created.
Ptr< Node > m_pgw
PGW network element.
DataRate m_s11LinkDataRate
The data rate to be used for the next S11 link to be created.
Ipv6AddressHelper m_uePgwAddressHelper6
helper to assign IPv6 addresses to UE devices as well as to the TUN device of the SGW/PGW
std::map< uint64_t, Ptr< NetDevice > > m_imsiEnbDeviceMap
Map storing for each IMSI the corresponding eNB NetDevice.
void AddEnb(Ptr< Node > enbNode, Ptr< NetDevice > lteEnbNetDevice, std::vector< uint16_t > cellIds) override
Add an eNB to the EPC.
virtual void DoActivateEpsBearerForUe(const Ptr< NetDevice > &ueDevice, const Ptr< EpcTft > &tft, const EpsBearer &bearer) const
DoActivateEpsBearerForUe: Schedule ActivateEpsBearer on the UE.
DataRate m_s5LinkDataRate
The data rate to be used for the next S5 link to be created.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:105
a unique identifier for an interface.
Definition: type-id.h:59
Every class exported by the ns3 library is enclosed in the ns3 namespace.