A Discrete-Event Network Simulator
API
ns3::EpcEnbApplication Class Reference

This application is installed inside eNBs and provides the bridge functionality for user data plane packets between the radio interface and the S1-U interface. More...

#include "epc-enb-application.h"

+ Inheritance diagram for ns3::EpcEnbApplication:
+ Collaboration diagram for ns3::EpcEnbApplication:

Classes

struct  EpsFlowId_t
 EPS flow ID structure. More...
 

Public Member Functions

 EpcEnbApplication (Ptr< Socket > lteSocket, Ptr< Socket > s1uSocket, Ipv4Address enbS1uAddress, Ipv4Address sgwS1uAddress, uint16_t cellId)
 Constructor. More...
 
virtual ~EpcEnbApplication (void)
 Destructor. More...
 
EpcS1apSapEnbGetS1apSapEnb ()
 
EpcEnbS1SapProviderGetS1SapProvider ()
 
void RecvFromLteSocket (Ptr< Socket > socket)
 Method to be assigned to the recv callback of the LTE socket. More...
 
void RecvFromS1uSocket (Ptr< Socket > socket)
 Method to be assigned to the recv callback of the S1-U socket. More...
 
void SetS1apSapMme (EpcS1apSapMme *s)
 Set the MME side of the S1-AP SAP. More...
 
void SetS1SapUser (EpcEnbS1SapUser *s)
 Set the S1 SAP User. More...
 
- Public Member Functions inherited from ns3::Application
 Application ()
 
virtual ~Application ()
 
Ptr< NodeGetNode () const
 
void SetNode (Ptr< Node > node)
 
void SetStartTime (Time start)
 Specify application start time. More...
 
void SetStopTime (Time stop)
 Specify application stop time. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Application
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Protected Member Functions

void DoDispose (void)
 Destructor implementation. More...
 
- Protected Member Functions inherited from ns3::Application
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Private Member Functions

void DoInitialContextSetupRequest (uint64_t mmeUeS1Id, uint16_t enbUeS1Id, std::list< EpcS1apSapEnb::ErabToBeSetupItem > erabToBeSetupList)
 Initial Context Setup Request. More...
 
void DoInitialUeMessage (uint64_t imsi, uint16_t rnti)
 Initial UE message function. More...
 
void DoPathSwitchRequest (EpcEnbS1SapProvider::PathSwitchRequestParameters params)
 Path switch request function. More...
 
void DoPathSwitchRequestAcknowledge (uint64_t enbUeS1Id, uint64_t mmeUeS1Id, uint16_t cgi, std::list< EpcS1apSapEnb::ErabSwitchedInUplinkItem > erabToBeSwitchedInUplinkList)
 Path Switch Request Acknowledge. More...
 
void DoReleaseIndication (uint64_t imsi, uint16_t rnti, uint8_t bearerId)
 This function accepts bearer id corresponding to a particular UE and schedules indication of bearer release towards MME. More...
 
void DoUeContextRelease (uint16_t rnti)
 UE Context Release function. More...
 
void SendToLteSocket (Ptr< Packet > packet, uint16_t rnti, uint8_t bid)
 Send a packet to the UE via the LTE radio interface of the eNB. More...
 
void SendToS1uSocket (Ptr< Packet > packet, uint32_t teid)
 Send a packet to the SGW via the S1-U interface. More...
 
void SetupS1Bearer (uint32_t teid, uint16_t rnti, uint8_t bid)
 internal method used for the actual setup of the S1 Bearer More...
 

Private Attributes

uint16_t m_cellId
 cell ID More...
 
Ipv4Address m_enbS1uAddress
 address of the eNB for S1-U communications More...
 
uint16_t m_gtpuUdpPort
 UDP port to be used for GTP. More...
 
std::map< uint64_t, uint16_t > m_imsiRntiMap
 UE context info. More...
 
Ptr< Socketm_lteSocket
 raw packet socket to send and receive the packets to and from the LTE radio interface More...
 
std::map< uint16_t, std::map< uint8_t, uint32_t > > m_rbidTeidMap
 map of maps telling for each RNTI and BID the corresponding S1-U TEID More...
 
EpcS1apSapEnbm_s1apSapEnb
 ENB side of the S1-AP SAP. More...
 
EpcS1apSapMmem_s1apSapMme
 MME side of the S1-AP SAP. More...
 
EpcEnbS1SapProviderm_s1SapProvider
 Provider for the S1 SAP. More...
 
EpcEnbS1SapUserm_s1SapUser
 User for the S1 SAP. More...
 
Ptr< Socketm_s1uSocket
 UDP socket to send and receive GTP-U the packets to and from the S1-U interface. More...
 
Ipv4Address m_sgwS1uAddress
 address of the SGW which terminates all S1-U tunnels More...
 
std::map< uint32_t, EpsFlowId_tm_teidRbidMap
 map telling for each S1-U TEID the corresponding RNTI,BID More...
 

Friends

class MemberEpcEnbS1SapProvider< EpcEnbApplication >
 allow MemberEpcEnbS1SapProvider<EpcEnbApplication> class friend access More...
 
class MemberEpcS1apSapEnb< EpcEnbApplication >
 allow MemberEpcS1apSapEnb<EpcEnbApplication> class friend access More...
 

Additional Inherited Members

- Protected Attributes inherited from ns3::Application
Ptr< Nodem_node
 The node that this application is installed on. More...
 
EventId m_startEvent
 The event that will fire at m_startTime to start the application. More...
 
Time m_startTime
 The simulation time that the application will start. More...
 
EventId m_stopEvent
 The event that will fire at m_stopTime to end the application. More...
 
Time m_stopTime
 The simulation time that the application will end. More...
 

Detailed Description

This application is installed inside eNBs and provides the bridge functionality for user data plane packets between the radio interface and the S1-U interface.

Definition at line 49 of file epc-enb-application.h.

Constructor & Destructor Documentation

ns3::EpcEnbApplication::EpcEnbApplication ( Ptr< Socket lteSocket,
Ptr< Socket s1uSocket,
Ipv4Address  enbS1uAddress,
Ipv4Address  sgwS1uAddress,
uint16_t  cellId 
)

Constructor.

Parameters
lteSocketthe socket to be used to send/receive packets to/from the LTE radio interface
s1uSocketthe socket to be used to send/receive packets to/from the S1-U interface connected with the SGW
enbS1uAddressthe IPv4 address of the S1-U interface of this eNB
sgwS1uAddressthe IPv4 address at which this eNB will be able to reach its SGW for S1-U communications
cellIdthe identifier of the enb

Definition at line 81 of file epc-enb-application.cc.

References m_lteSocket, m_s1apSapEnb, m_s1SapProvider, m_s1uSocket, ns3::MakeCallback(), NS_LOG_FUNCTION, RecvFromLteSocket(), RecvFromS1uSocket(), and ns3::Socket::SetRecvCallback().

+ Here is the call graph for this function:

ns3::EpcEnbApplication::~EpcEnbApplication ( void  )
virtual

Destructor.

Definition at line 99 of file epc-enb-application.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::EpcEnbApplication::DoDispose ( void  )
protectedvirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::Application.

Definition at line 71 of file epc-enb-application.cc.

References m_lteSocket, m_s1apSapEnb, m_s1SapProvider, m_s1uSocket, and NS_LOG_FUNCTION.

void ns3::EpcEnbApplication::DoInitialContextSetupRequest ( uint64_t  mmeUeS1Id,
uint16_t  enbUeS1Id,
std::list< EpcS1apSapEnb::ErabToBeSetupItem erabToBeSetupList 
)
private
void ns3::EpcEnbApplication::DoInitialUeMessage ( uint64_t  imsi,
uint16_t  rnti 
)
private

Initial UE message function.

Parameters
imsithe IMSI
rntithe RNTI

Definition at line 132 of file epc-enb-application.cc.

References ns3::EpcS1apSapMme::InitialUeMessage(), m_cellId, m_imsiRntiMap, m_s1apSapMme, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

void ns3::EpcEnbApplication::DoPathSwitchRequestAcknowledge ( uint64_t  enbUeS1Id,
uint64_t  mmeUeS1Id,
uint16_t  cgi,
std::list< EpcS1apSapEnb::ErabSwitchedInUplinkItem erabToBeSwitchedInUplinkList 
)
private

Path Switch Request Acknowledge.

Parameters
mmeUeS1Idthe MME UE S1 ID
enbUeS1Idthe ENB UE S1 ID
cgithe CGI
erabToBeSwitchedInUplinkListthe ERAB switched in uplink list

Definition at line 226 of file epc-enb-application.cc.

References m_imsiRntiMap, m_s1SapUser, NS_ASSERT_MSG, NS_LOG_FUNCTION, ns3::EpcEnbS1SapUser::PathSwitchRequestAcknowledge(), and ns3::EpcEnbS1SapUser::PathSwitchRequestAcknowledgeParameters::rnti.

+ Here is the call graph for this function:

void ns3::EpcEnbApplication::DoReleaseIndication ( uint64_t  imsi,
uint16_t  rnti,
uint8_t  bearerId 
)
private

This function accepts bearer id corresponding to a particular UE and schedules indication of bearer release towards MME.

Parameters
imsimaps to mmeUeS1Id
rntimaps to enbUeS1Id
bearerIdBearer Identity which is to be de-activated

Definition at line 307 of file epc-enb-application.cc.

References ns3::EpcS1apSapMme::ErabToBeReleasedIndication::erabId, ns3::EpcS1apSapMme::ErabReleaseIndication(), m_s1apSapMme, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

void ns3::EpcEnbApplication::DoUeContextRelease ( uint16_t  rnti)
private

UE Context Release function.

Parameters
rntithe RNTI

Definition at line 177 of file epc-enb-application.cc.

References m_rbidTeidMap, m_teidRbidMap, and NS_LOG_FUNCTION.

EpcS1apSapEnb * ns3::EpcEnbApplication::GetS1apSapEnb ( )
Returns
the ENB side of the S1-AP SAP

Definition at line 126 of file epc-enb-application.cc.

References m_s1apSapEnb.

EpcEnbS1SapProvider * ns3::EpcEnbApplication::GetS1SapProvider ( )
Returns
the S1 SAP Provider

Definition at line 113 of file epc-enb-application.cc.

References m_s1SapProvider.

Referenced by EpcS1uDlTestCase::DoRun(), and EpcS1uUlTestCase::DoRun().

+ Here is the caller graph for this function:

TypeId ns3::EpcEnbApplication::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

Definition at line 62 of file epc-enb-application.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

void ns3::EpcEnbApplication::RecvFromLteSocket ( Ptr< Socket socket)

Method to be assigned to the recv callback of the LTE socket.

It is called when the eNB receives a data packet from the radio interface that is to be forwarded to the SGW.

Parameters
socketpointer to the LTE socket

Definition at line 240 of file epc-enb-application.cc.

References ns3::EpsBearerTag::GetBid(), ns3::EpsBearerTag::GetRnti(), m_lteSocket, m_rbidTeidMap, NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_LOGIC(), NS_LOG_WARN, ns3::Socket::Recv(), ns3::Packet::RemovePacketTag(), and SendToS1uSocket().

Referenced by EpcEnbApplication().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::EpcEnbApplication::RecvFromS1uSocket ( Ptr< Socket socket)

Method to be assigned to the recv callback of the S1-U socket.

It is called when the eNB receives a data packet from the SGW that is to be forwarded to the UE.

Parameters
socketpointer to the S1-U socket

Definition at line 267 of file epc-enb-application.cc.

References ns3::GtpuHeader::GetTeid(), m_s1uSocket, m_teidRbidMap, NS_ASSERT, NS_LOG_FUNCTION, ns3::Socket::Recv(), ns3::Packet::RemoveHeader(), and SendToLteSocket().

Referenced by EpcEnbApplication().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::EpcEnbApplication::SendToLteSocket ( Ptr< Packet packet,
uint16_t  rnti,
uint8_t  bid 
)
private

Send a packet to the UE via the LTE radio interface of the eNB.

Parameters
packett
rntimaps to enbUeS1Id
bidthe EPS Bearer IDentifier

Definition at line 282 of file epc-enb-application.cc.

References ns3::Packet::AddPacketTag(), ns3::Packet::GetSize(), m_lteSocket, NS_ASSERT, NS_LOG_FUNCTION, and ns3::Socket::Send().

Referenced by RecvFromS1uSocket().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::EpcEnbApplication::SendToS1uSocket ( Ptr< Packet packet,
uint32_t  teid 
)
private

Send a packet to the SGW via the S1-U interface.

Parameters
packetpacket to be sent
teidthe Tunnel Enpoint IDentifier

Definition at line 293 of file epc-enb-application.cc.

References ns3::Packet::AddHeader(), ns3::Packet::GetSize(), m_gtpuUdpPort, m_s1uSocket, m_sgwS1uAddress, NS_LOG_FUNCTION, ns3::Socket::SendTo(), and ns3::GtpuHeader::SetTeid().

Referenced by RecvFromLteSocket().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::EpcEnbApplication::SetS1apSapMme ( EpcS1apSapMme s)

Set the MME side of the S1-AP SAP.

Parameters
sthe MME side of the S1-AP SAP

Definition at line 119 of file epc-enb-application.cc.

References m_s1apSapMme.

void ns3::EpcEnbApplication::SetS1SapUser ( EpcEnbS1SapUser s)

Set the S1 SAP User.

Parameters
sthe S1 SAP User

Definition at line 106 of file epc-enb-application.cc.

References m_s1SapUser.

Referenced by EpcS1uDlTestCase::DoRun(), and EpcS1uUlTestCase::DoRun().

+ Here is the caller graph for this function:

void ns3::EpcEnbApplication::SetupS1Bearer ( uint32_t  teid,
uint16_t  rnti,
uint8_t  bid 
)
private

internal method used for the actual setup of the S1 Bearer

Parameters
teidthe Tunnel Endpoint IDentifier
rntimaps to enbUeS1Id
bidthe S1-U Bearer IDentifier

Friends And Related Function Documentation

allow MemberEpcEnbS1SapProvider<EpcEnbApplication> class friend access

Definition at line 53 of file epc-enb-application.h.

friend class MemberEpcS1apSapEnb< EpcEnbApplication >
friend

allow MemberEpcS1apSapEnb<EpcEnbApplication> class friend access

Definition at line 55 of file epc-enb-application.h.

Member Data Documentation

uint16_t ns3::EpcEnbApplication::m_cellId
private

cell ID

Definition at line 308 of file epc-enb-application.h.

Referenced by DoInitialUeMessage().

Ipv4Address ns3::EpcEnbApplication::m_enbS1uAddress
private

address of the eNB for S1-U communications

Definition at line 256 of file epc-enb-application.h.

Referenced by DoPathSwitchRequest().

uint16_t ns3::EpcEnbApplication::m_gtpuUdpPort
private

UDP port to be used for GTP.

Definition at line 278 of file epc-enb-application.h.

Referenced by SendToS1uSocket().

std::map<uint64_t, uint16_t> ns3::EpcEnbApplication::m_imsiRntiMap
private
Ptr<Socket> ns3::EpcEnbApplication::m_lteSocket
private

raw packet socket to send and receive the packets to and from the LTE radio interface

Definition at line 246 of file epc-enb-application.h.

Referenced by DoDispose(), EpcEnbApplication(), RecvFromLteSocket(), and SendToLteSocket().

std::map<uint16_t, std::map<uint8_t, uint32_t> > ns3::EpcEnbApplication::m_rbidTeidMap
private

map of maps telling for each RNTI and BID the corresponding S1-U TEID

Definition at line 267 of file epc-enb-application.h.

Referenced by DoInitialContextSetupRequest(), DoPathSwitchRequest(), DoUeContextRelease(), and RecvFromLteSocket().

EpcS1apSapEnb* ns3::EpcEnbApplication::m_s1apSapEnb
private

ENB side of the S1-AP SAP.

Definition at line 300 of file epc-enb-application.h.

Referenced by DoDispose(), EpcEnbApplication(), and GetS1apSapEnb().

EpcS1apSapMme* ns3::EpcEnbApplication::m_s1apSapMme
private

MME side of the S1-AP SAP.

Definition at line 294 of file epc-enb-application.h.

Referenced by DoInitialUeMessage(), DoPathSwitchRequest(), DoReleaseIndication(), and SetS1apSapMme().

EpcEnbS1SapProvider* ns3::EpcEnbApplication::m_s1SapProvider
private

Provider for the S1 SAP.

Definition at line 283 of file epc-enb-application.h.

Referenced by DoDispose(), EpcEnbApplication(), and GetS1SapProvider().

EpcEnbS1SapUser* ns3::EpcEnbApplication::m_s1SapUser
private

User for the S1 SAP.

Definition at line 288 of file epc-enb-application.h.

Referenced by DoInitialContextSetupRequest(), DoPathSwitchRequestAcknowledge(), and SetS1SapUser().

Ptr<Socket> ns3::EpcEnbApplication::m_s1uSocket
private

UDP socket to send and receive GTP-U the packets to and from the S1-U interface.

Definition at line 251 of file epc-enb-application.h.

Referenced by DoDispose(), EpcEnbApplication(), RecvFromS1uSocket(), and SendToS1uSocket().

Ipv4Address ns3::EpcEnbApplication::m_sgwS1uAddress
private

address of the SGW which terminates all S1-U tunnels

Definition at line 261 of file epc-enb-application.h.

Referenced by SendToS1uSocket().

std::map<uint32_t, EpsFlowId_t> ns3::EpcEnbApplication::m_teidRbidMap
private

map telling for each S1-U TEID the corresponding RNTI,BID

Definition at line 273 of file epc-enb-application.h.

Referenced by DoInitialContextSetupRequest(), DoPathSwitchRequest(), DoUeContextRelease(), and RecvFromS1uSocket().


The documentation for this class was generated from the following files: