A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
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 * SPDX-License-Identifier: GPL-2.0-only
5 *
6 * Author: Manuel Requena <manuel.requena@cttc.es>
7 * (based on the original point-to-point-epc-helper.h)
8 */
9
10#ifndef NO_BACKHAUL_EPC_HELPER_H
11#define NO_BACKHAUL_EPC_HELPER_H
12
13#include "epc-helper.h"
14
15namespace ns3
16{
17
18class EpcSgwApplication;
19class EpcPgwApplication;
20class EpcMmeApplication;
21
22/**
23 * @ingroup lte
24 * @brief Create an EPC network with PointToPoint links between the core network nodes.
25 *
26 * This Helper will create an EPC network topology comprising of
27 * three nodes: SGW, PGW and MME.
28 * The X2-U, X2-C, S5 and S11 interfaces are realized over PointToPoint links.
29 *
30 * The S1 interface is not created. So, no backhaul network is built.
31 * You have to build your own backhaul network in the simulation program.
32 * Or you can use PointToPointEpcHelper or CsmaEpcHelper
33 * (instead of this NoBackhaulEpcHelper) to use reference backhaul networks.
34 */
36{
37 public:
38 /**
39 * Constructor
40 */
42
43 /**
44 * Destructor
45 */
46 ~NoBackhaulEpcHelper() override;
47
48 // inherited from Object
49 /**
50 * Register this type.
51 * @return The object TypeId.
52 */
53 static TypeId GetTypeId();
54 TypeId GetInstanceTypeId() const override;
55 void DoDispose() override;
56
57 // inherited from EpcHelper
58 void AddEnb(Ptr<Node> enbNode,
59 Ptr<NetDevice> lteEnbNetDevice,
60 std::vector<uint16_t> cellIds) override;
61 void AddUe(Ptr<NetDevice> ueLteDevice, uint64_t imsi) override;
62 void AddX2Interface(Ptr<Node> enbNode1, Ptr<Node> enbNode2) override;
64 Ipv4Address enbAddress,
65 Ipv4Address sgwAddress,
66 std::vector<uint16_t> cellIds) override;
67 uint8_t ActivateEpsBearer(Ptr<NetDevice> ueLteDevice,
68 uint64_t imsi,
69 Ptr<EpcTft> tft,
70 EpsBearer bearer) override;
71 Ptr<Node> GetSgwNode() const override;
72 Ptr<Node> GetPgwNode() const override;
77 int64_t AssignStreams(int64_t stream) override;
78
79 protected:
80 /**
81 * @brief DoAddX2Interface: Call AddX2Interface on top of the Enb device pointers
82 *
83 * @param enb1X2 EPCX2 of ENB1
84 * @param enb1LteDev LTE device of ENB1
85 * @param enb1X2Address Address for ENB1
86 * @param enb2X2 EPCX2 of ENB2
87 * @param enb2LteDev LTE device of ENB2
88 * @param enb2X2Address Address for ENB2
89 */
90 virtual void DoAddX2Interface(const Ptr<EpcX2>& enb1X2,
91 const Ptr<NetDevice>& enb1LteDev,
92 const Ipv4Address& enb1X2Address,
93 const Ptr<EpcX2>& enb2X2,
94 const Ptr<NetDevice>& enb2LteDev,
95 const Ipv4Address& enb2X2Address) const;
96
97 /**
98 * @brief DoActivateEpsBearerForUe: Schedule ActivateEpsBearer on the UE
99 * @param ueDevice LTE device for the UE
100 * @param tft TFT
101 * @param bearer Bearer
102 */
103 virtual void DoActivateEpsBearerForUe(const Ptr<NetDevice>& ueDevice,
104 const Ptr<EpcTft>& tft,
105 const EpsBearer& bearer) const;
106
107 private:
108 /**
109 * helper to assign IPv4 addresses to UE devices as well as to the TUN device of the SGW/PGW
110 */
112 /**
113 * helper to assign IPv6 addresses to UE devices as well as to the TUN device of the SGW/PGW
114 */
116
117 /**
118 * PGW network element
119 */
121
122 /**
123 * SGW network element
124 */
126
127 /**
128 * MME network element
129 */
131
132 /**
133 * SGW application
134 */
136
137 /**
138 * PGW application
139 */
141
142 /**
143 * MME application
144 */
146
147 /**
148 * TUN device implementing tunneling of user data over GTP-U/UDP/IP
149 */
151
152 /**
153 * UDP port where the GTP-U Socket is bound, fixed by the standard as 2152
154 */
156
157 /**
158 * Helper to assign addresses to S11 NetDevices
159 */
161
162 /**
163 * The data rate to be used for the next S11 link to be created
164 */
166
167 /**
168 * The delay to be used for the next S11 link to be created
169 */
171
172 /**
173 * The MTU of the next S11 link to be created
174 */
175 uint16_t m_s11LinkMtu;
176
177 /**
178 * UDP port where the GTPv2-C Socket is bound, fixed by the standard as 2123
179 */
181
182 /**
183 * S5 interfaces
184 */
185
186 /**
187 * Helper to assign addresses to S5 NetDevices
188 */
190
191 /**
192 * The data rate to be used for the next S5 link to be created
193 */
195
196 /**
197 * The delay to be used for the next S5 link to be created
198 */
200
201 /**
202 * The MTU of the next S5 link to be created
203 */
204 uint16_t m_s5LinkMtu;
205
206 /**
207 * Map storing for each IMSI the corresponding eNB NetDevice
208 */
209 std::map<uint64_t, Ptr<NetDevice>> m_imsiEnbDeviceMap;
210
211 /**
212 * helper to assign addresses to X2 NetDevices
213 */
215
216 /**
217 * The data rate to be used for the next X2 link to be created
218 */
220
221 /**
222 * The delay to be used for the next X2 link to be created
223 */
225
226 /**
227 * The MTU of the next X2 link to be created. Note that,
228 * because of some big X2 messages, you need a big MTU.
229 */
230 uint16_t m_x2LinkMtu;
231
232 /**
233 * Enable PCAP generation for X2 link
234 */
236
237 /**
238 * Prefix for the PCAP file for the X2 link
239 */
241};
242
243} // namespace ns3
244
245#endif // NO_BACKHAUL_EPC_HELPER_H
Class for representing data rates.
Definition data-rate.h:78
Base helper class to handle the creation of the EPC entities.
Definition epc-helper.h:40
This class contains the specification of EPS Bearers.
Definition eps-bearer.h:80
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.
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.
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.
Smart pointer class similar to boost::intrusive_ptr.
Simulation virtual time values and global simulation resolution.
Definition nstime.h:94
a unique identifier for an interface.
Definition type-id.h:48
Every class exported by the ns3 library is enclosed in the ns3 namespace.