A Discrete-Event Network Simulator
API
epc-sgw-pgw-application.cc
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
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 <jnin@cttc.cat>
19  * Nicola Baldo <nbaldo@cttc.cat>
20  */
21 
22 
24 #include "ns3/log.h"
25 #include "ns3/mac48-address.h"
26 #include "ns3/ipv4.h"
27 #include "ns3/inet-socket-address.h"
28 #include "ns3/epc-gtpu-header.h"
29 #include "ns3/abort.h"
30 
31 namespace ns3 {
32 
33 NS_LOG_COMPONENT_DEFINE ("EpcSgwPgwApplication");
34 
36 // UeInfo
38 
39 
41 {
42  NS_LOG_FUNCTION (this);
43 }
44 
45 void
46 EpcSgwPgwApplication::UeInfo::AddBearer (Ptr<EpcTft> tft, uint8_t bearerId, uint32_t teid)
47 {
48  NS_LOG_FUNCTION (this << tft << teid);
49  m_teidByBearerIdMap[bearerId] = teid;
50  return m_tftClassifier.Add (tft, teid);
51 }
52 
53 void
55 {
56  NS_LOG_FUNCTION (this << bearerId);
57  m_teidByBearerIdMap.erase (bearerId);
58 }
59 
60 uint32_t
62 {
63  NS_LOG_FUNCTION (this << p);
64  // we hardcode DOWNLINK direction since the PGW is espected to
65  // classify only downlink packets (uplink packets will go to the
66  // internet without any classification).
67  return m_tftClassifier.Classify (p, EpcTft::DOWNLINK);
68 }
69 
72 {
73  return m_enbAddr;
74 }
75 
76 void
78 {
79  m_enbAddr = enbAddr;
80 }
81 
84 {
85  return m_ueAddr;
86 }
87 
88 void
90 {
91  m_ueAddr = ueAddr;
92 }
93 
95 // EpcSgwPgwApplication
97 
98 
99 TypeId
101 {
102  static TypeId tid = TypeId ("ns3::EpcSgwPgwApplication")
103  .SetParent<Object> ();
104  return tid;
105 }
106 
107 void
109 {
110  NS_LOG_FUNCTION (this);
112  m_s1uSocket = 0;
113  delete (m_s11SapSgw);
114 }
115 
116 
117 
119  : m_s1uSocket (s1uSocket),
120  m_tunDevice (tunDevice),
121  m_gtpuUdpPort (2152), // fixed by the standard
122  m_teidCount (0),
123  m_s11SapMme (0)
124 {
125  NS_LOG_FUNCTION (this << tunDevice << s1uSocket);
128 }
129 
130 
132 {
133  NS_LOG_FUNCTION (this);
134 }
135 
136 
137 bool
138 EpcSgwPgwApplication::RecvFromTunDevice (Ptr<Packet> packet, const Address& source, const Address& dest, uint16_t protocolNumber)
139 {
140  NS_LOG_FUNCTION (this << source << dest << packet << packet->GetSize ());
141 
142  // get IP address of UE
143  Ptr<Packet> pCopy = packet->Copy ();
144  Ipv4Header ipv4Header;
145  pCopy->RemoveHeader (ipv4Header);
146  Ipv4Address ueAddr = ipv4Header.GetDestination ();
147  NS_LOG_LOGIC ("packet addressed to UE " << ueAddr);
148 
149  // find corresponding UeInfo address
150  std::map<Ipv4Address, Ptr<UeInfo> >::iterator it = m_ueInfoByAddrMap.find (ueAddr);
151  if (it == m_ueInfoByAddrMap.end ())
152  {
153  NS_LOG_WARN ("unknown UE address " << ueAddr);
154  }
155  else
156  {
157  Ipv4Address enbAddr = it->second->GetEnbAddr ();
158  uint32_t teid = it->second->Classify (packet);
159  if (teid == 0)
160  {
161  NS_LOG_WARN ("no matching bearer for this packet");
162  }
163  else
164  {
165  SendToS1uSocket (packet, enbAddr, teid);
166  }
167  }
168  // there is no reason why we should notify the TUN
169  // VirtualNetDevice that he failed to send the packet: if we receive
170  // any bogus packet, it will just be silently discarded.
171  const bool succeeded = true;
172  return succeeded;
173 }
174 
175 void
177 {
178  NS_LOG_FUNCTION (this << socket);
179  NS_ASSERT (socket == m_s1uSocket);
180  Ptr<Packet> packet = socket->Recv ();
181  GtpuHeader gtpu;
182  packet->RemoveHeader (gtpu);
183  uint32_t teid = gtpu.GetTeid ();
184 
187  SocketAddressTag tag;
188  packet->RemovePacketTag (tag);
189 
190  SendToTunDevice (packet, teid);
191 }
192 
193 void
195 {
196  NS_LOG_FUNCTION (this << packet << teid);
197  NS_LOG_LOGIC (" packet size: " << packet->GetSize () << " bytes");
199 }
200 
201 void
203 {
204  NS_LOG_FUNCTION (this << packet << enbAddr << teid);
205 
206  GtpuHeader gtpu;
207  gtpu.SetTeid (teid);
208  // From 3GPP TS 29.281 v10.0.0 Section 5.1
209  // Length of the payload + the non obligatory GTP-U header
210  gtpu.SetLength (packet->GetSize () + gtpu.GetSerializedSize () - 8);
211  packet->AddHeader (gtpu);
212  uint32_t flags = 0;
213  m_s1uSocket->SendTo (packet, flags, InetSocketAddress (enbAddr, m_gtpuUdpPort));
214 }
215 
216 
217 void
219 {
220  m_s11SapMme = s;
221 }
222 
223 EpcS11SapSgw*
225 {
226  return m_s11SapSgw;
227 }
228 
229 void
230 EpcSgwPgwApplication::AddEnb (uint16_t cellId, Ipv4Address enbAddr, Ipv4Address sgwAddr)
231 {
232  NS_LOG_FUNCTION (this << cellId << enbAddr << sgwAddr);
233  EnbInfo enbInfo;
234  enbInfo.enbAddr = enbAddr;
235  enbInfo.sgwAddr = sgwAddr;
236  m_enbInfoByCellId[cellId] = enbInfo;
237 }
238 
239 void
241 {
242  NS_LOG_FUNCTION (this << imsi);
243  Ptr<UeInfo> ueInfo = Create<UeInfo> ();
244  m_ueInfoByImsiMap[imsi] = ueInfo;
245 }
246 
247 void
249 {
250  NS_LOG_FUNCTION (this << imsi << ueAddr);
251  std::map<uint64_t, Ptr<UeInfo> >::iterator ueit = m_ueInfoByImsiMap.find (imsi);
252  NS_ASSERT_MSG (ueit != m_ueInfoByImsiMap.end (), "unknown IMSI " << imsi);
253  m_ueInfoByAddrMap[ueAddr] = ueit->second;
254  ueit->second->SetUeAddr (ueAddr);
255 }
256 
257 void
259 {
260  NS_LOG_FUNCTION (this << req.imsi);
261  std::map<uint64_t, Ptr<UeInfo> >::iterator ueit = m_ueInfoByImsiMap.find (req.imsi);
262  NS_ASSERT_MSG (ueit != m_ueInfoByImsiMap.end (), "unknown IMSI " << req.imsi);
263  uint16_t cellId = req.uli.gci;
264  std::map<uint16_t, EnbInfo>::iterator enbit = m_enbInfoByCellId.find (cellId);
265  NS_ASSERT_MSG (enbit != m_enbInfoByCellId.end (), "unknown CellId " << cellId);
266  Ipv4Address enbAddr = enbit->second.enbAddr;
267  ueit->second->SetEnbAddr (enbAddr);
268 
270  res.teid = req.imsi; // trick to avoid the need for allocating TEIDs on the S11 interface
271 
272  for (std::list<EpcS11SapSgw::BearerContextToBeCreated>::iterator bit = req.bearerContextsToBeCreated.begin ();
273  bit != req.bearerContextsToBeCreated.end ();
274  ++bit)
275  {
276  // simple sanity check. If you ever need more than 4M teids
277  // throughout your simulation, you'll need to implement a smarter teid
278  // management algorithm.
279  NS_ABORT_IF (m_teidCount == 0xFFFFFFFF);
280  uint32_t teid = ++m_teidCount;
281  ueit->second->AddBearer (bit->tft, bit->epsBearerId, teid);
282 
284  bearerContext.sgwFteid.teid = teid;
285  bearerContext.sgwFteid.address = enbit->second.sgwAddr;
286  bearerContext.epsBearerId = bit->epsBearerId;
287  bearerContext.bearerLevelQos = bit->bearerLevelQos;
288  bearerContext.tft = bit->tft;
289  res.bearerContextsCreated.push_back (bearerContext);
290  }
292 
293 }
294 
295 void
297 {
298  NS_LOG_FUNCTION (this << req.teid);
299  uint64_t imsi = req.teid; // trick to avoid the need for allocating TEIDs on the S11 interface
300  std::map<uint64_t, Ptr<UeInfo> >::iterator ueit = m_ueInfoByImsiMap.find (imsi);
301  NS_ASSERT_MSG (ueit != m_ueInfoByImsiMap.end (), "unknown IMSI " << imsi);
302  uint16_t cellId = req.uli.gci;
303  std::map<uint16_t, EnbInfo>::iterator enbit = m_enbInfoByCellId.find (cellId);
304  NS_ASSERT_MSG (enbit != m_enbInfoByCellId.end (), "unknown CellId " << cellId);
305  Ipv4Address enbAddr = enbit->second.enbAddr;
306  ueit->second->SetEnbAddr (enbAddr);
307  // no actual bearer modification: for now we just support the minimum needed for path switch request (handover)
309  res.teid = imsi; // trick to avoid the need for allocating TEIDs on the S11 interface
312 }
313 
314 void
316 {
317  NS_LOG_FUNCTION (this << req.teid);
318  uint64_t imsi = req.teid; // trick to avoid the need for allocating TEIDs on the S11 interface
319  std::map<uint64_t, Ptr<UeInfo> >::iterator ueit = m_ueInfoByImsiMap.find (imsi);
320  NS_ASSERT_MSG (ueit != m_ueInfoByImsiMap.end (), "unknown IMSI " << imsi);
321 
323  res.teid = imsi;
324 
325  for (std::list<EpcS11SapSgw::BearerContextToBeRemoved>::iterator bit = req.bearerContextsToBeRemoved.begin ();
326  bit != req.bearerContextsToBeRemoved.end ();
327  ++bit)
328  {
330  bearerContext.epsBearerId = bit->epsBearerId;
331  res.bearerContextsRemoved.push_back (bearerContext);
332  }
333  //schedules Delete Bearer Request towards MME
335 }
336 
337 void
339 {
340  NS_LOG_FUNCTION (this << req.teid);
341  uint64_t imsi = req.teid; // trick to avoid the need for allocating TEIDs on the S11 interface
342  std::map<uint64_t, Ptr<UeInfo> >::iterator ueit = m_ueInfoByImsiMap.find (imsi);
343  NS_ASSERT_MSG (ueit != m_ueInfoByImsiMap.end (), "unknown IMSI " << imsi);
344 
345  for (std::list<EpcS11SapSgw::BearerContextRemovedSgwPgw>::iterator bit = req.bearerContextsRemoved.begin ();
346  bit != req.bearerContextsRemoved.end ();
347  ++bit)
348  {
349  //Function to remove de-activated bearer contexts from S-Gw and P-Gw side
350  ueit->second->RemoveBearer (bit->epsBearerId);
351  }
352 }
353 
354 } // namespace ns3
uint32_t RemoveHeader(Header &header)
Deserialize and remove the header from the internal buffer.
Definition: packet.cc:268
std::map< uint16_t, EnbInfo > m_enbInfoByCellId
enum ns3::EpcS11SapMme::ModifyBearerResponseMessage::Cause cause
an Inet address class
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by "...
3GPP TS 29.274 version 8.3.1 Release 8 section 8.28
Definition: epc-s11-sap.h:80
Delete Bearer Command message, see 3GPP TS 29.274 Release 9 V9.3.0 section 7.2.17.1.
Definition: epc-s11-sap.h:194
Ipv4Address address
Definition: epc-s11-sap.h:51
MME side of the S11 Service Access Point (SAP), provides the MME methods to be called when an S11 mes...
Definition: epc-s11-sap.h:72
uint16_t m_gtpuUdpPort
UDP port to be used for GTP.
void SetS11SapMme(EpcS11SapMme *s)
Set the MME side of the S11 SAP.
Ipv4Address GetDestination(void) const
Definition: ipv4-header.cc:304
EpcS11SapMme * m_s11SapMme
MME side of the S11 SAP.
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file...
Definition: assert.h:61
Delete Bearer Request message, see 3GPP TS 29.274 Release 9 V9.3.0 section 7.2.9.2.
Definition: epc-s11-sap.h:114
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:201
std::list< BearerContextRemovedSgwPgw > bearerContextsRemoved
Definition: epc-s11-sap.h:215
uint32_t GetSize(void) const
Returns the the size in bytes of the packet (including the zero-filled initial payload).
Definition: packet.h:766
bool Receive(Ptr< Packet > packet, uint16_t protocol, const Address &source, const Address &destination, PacketType packetType)
Callback< R > MakeNullCallback(void)
Definition: callback.h:1436
Packet addressed oo us.
Definition: net-device.h:274
std::list< BearerContextToBeRemoved > bearerContextsToBeRemoved
Definition: epc-s11-sap.h:196
void SendToTunDevice(Ptr< Packet > packet, uint32_t teid)
Send a packet to the internet via the Gi interface of the SGW/PGW.
virtual void DeleteBearerRequest(DeleteBearerRequestMessage msg)=0
As per 3GPP TS 29.274 Release 9 V9.3.0, a Delete Bearer Request message shall be sent on the S11 inte...
Delete Bearer Response message, see 3GPP TS 29.274 Release 9 V9.3.0 section 7.2.10.2.
Definition: epc-s11-sap.h:213
a polymophic address class
Definition: address.h:90
Template for the implementation of the EpcS11SapSgw as a member of an owner class of type C to which ...
Definition: epc-s11-sap.h:307
Packet header for IPv4.
Definition: ipv4-header.h:31
virtual Address GetAddress(void) const
void RemoveBearer(uint8_t bearerId)
Function, deletes contexts of bearer on SGW and PGW side.
virtual uint32_t GetSerializedSize(void) const
bool RecvFromTunDevice(Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber)
Method to be assigned to the callback of the Gi TUN VirtualNetDevice.
Ptr< SampleEmitter > s
Ptr< VirtualNetDevice > m_tunDevice
TUN VirtualNetDevice used for tunneling/detunneling IP packets from/to the internet over GTP-U/UDP/IP...
std::map< uint64_t, Ptr< UeInfo > > m_ueInfoByImsiMap
Map telling for each IMSI the corresponding UE info.
void DoCreateSessionRequest(EpcS11SapSgw::CreateSessionRequestMessage msg)
void SetUeAddr(Ipv4Address addr)
set the address of the UE
virtual void ModifyBearerResponse(ModifyBearerResponseMessage msg)=0
send a Modify Bearer Response message
This class implements a tag that carries an address of a packet across the socket interface...
Definition: socket.h:951
Callback< R > MakeCallback(R(T::*memPtr)(void), OBJ objPtr)
Definition: callback.h:1290
void SetRecvCallback(Callback< void, Ptr< Socket > >)
Notify application when new data is available to be read.
Definition: socket.cc:127
#define NS_LOG_LOGIC(msg)
Use NS_LOG to output a message of level LOG_LOGIC.
Definition: log.h:252
Modify Bearer Request message, see 3GPP TS 29.274 7.2.7.
Definition: epc-s11-sap.h:227
Ptr< Packet > Copy(void) const
performs a COW copy of the packet.
Definition: packet.cc:122
Every class exported by the ns3 library is enclosed in the ns3 namespace.
void SetTeid(uint32_t m_teid)
void AddBearer(Ptr< EpcTft > tft, uint8_t epsBearerId, uint32_t teid)
virtual Ptr< Packet > Recv(uint32_t maxSize, uint32_t flags)=0
Read data from the socket.
std::list< BearerContextCreated > bearerContextsCreated
Definition: epc-s11-sap.h:95
void SetUeAddress(uint64_t imsi, Ipv4Address ueAddr)
set the address of a previously added UE
void DoDeleteBearerResponse(EpcS11SapSgw::DeleteBearerResponseMessage req)
uint32_t GetTeid() const
void AddUe(uint64_t imsi)
Let the SGW be aware of a new UE.
void SendToS1uSocket(Ptr< Packet > packet, Ipv4Address enbS1uAddress, uint32_t teid)
Send a packet to the SGW via the S1-U interface.
#define NS_ASSERT_MSG(condition, message)
At runtime, in debugging builds, if this condition is not true, the program prints the message to out...
Definition: assert.h:84
Ptr< Socket > m_s1uSocket
UDP socket to send and receive GTP-U packets to and from the S1-U interface.
#define NS_ABORT_IF(cond)
Abnormal program termination if a condition is true.
Definition: abort.h:77
std::map< Ipv4Address, Ptr< UeInfo > > m_ueInfoByAddrMap
Map telling for each UE address the corresponding UE info.
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:40
void DoDeleteBearerCommand(EpcS11SapSgw::DeleteBearerCommandMessage req)
SGW side of the S11 Service Access Point (SAP), provides the SGW methods to be called when an S11 mes...
Definition: epc-s11-sap.h:156
std::list< BearerContextToBeCreated > bearerContextsToBeCreated
Definition: epc-s11-sap.h:176
virtual void CreateSessionResponse(CreateSessionResponseMessage msg)=0
send a Create Session Response message
void SetEnbAddr(Ipv4Address addr)
set the address of the eNB to which the UE is connected
#define NS_LOG_WARN(msg)
Use NS_LOG to output a message of level LOG_WARN.
Definition: log.h:228
bool RemovePacketTag(Tag &tag)
Remove a packet tag.
Definition: packet.cc:843
virtual void DoDispose()
Destructor implementation.
void SetLength(uint16_t m_length)
void RecvFromS1uSocket(Ptr< Socket > socket)
Method to be assigned to the recv callback of the S1-U socket.
virtual ~EpcSgwPgwApplication(void)
Destructor.
virtual int SendTo(Ptr< Packet > p, uint32_t flags, const Address &toAddress)=0
Send data to a specified peer.
A base class which provides memory management and object aggregation.
Definition: object.h:87
Modify Bearer Response message, see 3GPP TS 29.274 7.2.7.
Definition: epc-s11-sap.h:131
void DoModifyBearerRequest(EpcS11SapSgw::ModifyBearerRequestMessage msg)
EpcS11SapSgw * m_s11SapSgw
SGW side of the S11 SAP.
a unique identifier for an interface.
Definition: type-id.h:51
TypeId SetParent(TypeId tid)
Definition: type-id.cc:631
void AddEnb(uint16_t cellId, Ipv4Address enbAddr, Ipv4Address sgwAddr)
Let the SGW be aware of a new eNB.
void AddHeader(const Header &header)
Add header to this packet.
Definition: packet.cc:253
Create Session Request message, see 3GPP TS 29.274 7.2.1.
Definition: epc-s11-sap.h:172
EpcSgwPgwApplication(const Ptr< VirtualNetDevice > tunDevice, const Ptr< Socket > s1uSocket)
Constructor that binds the tap device to the callback methods.
Implementation of the GTPv1-U Release 10 as per 3Gpp TS 29.281 document.
Create Session Response message, see 3GPP TS 29.274 7.2.2.
Definition: epc-s11-sap.h:93