Create an EPC network using EmuFdNetDevice. More...

#include "emu-epc-helper.h"

Inheritance diagram for ns3::EmuEpcHelper:

Public Member Functions
	EmuEpcHelper ()
	Constructor. More...

virtual	~EmuEpcHelper ()
	Destructor. More...

virtual uint8_t	ActivateEpsBearer (Ptr< NetDevice > ueLteDevice, uint64_t imsi, Ptr< EpcTft > tft, EpsBearer bearer)
	Activate an EPS bearer, setting up the corresponding S1-U tunnel. More...

virtual void	AddEnb (Ptr< Node > enbNode, Ptr< NetDevice > lteEnbNetDevice, uint16_t cellId)
	Add an eNB to the EPC. More...

virtual void	AddUe (Ptr< NetDevice > ueLteDevice, uint64_t imsi)
	Notify the EPC of the existence of a new UE which might attach at a later time. More...

virtual void	AddX2Interface (Ptr< Node > enbNode1, Ptr< Node > enbNode2)
	Add an X2 interface between two eNB. More...

virtual Ipv4InterfaceContainer	AssignUeIpv4Address (NetDeviceContainer ueDevices)
	Assign IPv4 addresses to UE devices. More...

virtual Ipv6InterfaceContainer	AssignUeIpv6Address (NetDeviceContainer ueDevices)
	Assign IPv6 addresses to UE devices. More...

virtual void	DoDispose ()
	Destructor implementation. More...

virtual void	DoInitialize ()
	Initialize() implementation. More...

TypeId	GetInstanceTypeId () const
	Get the most derived TypeId for this Object. More...

virtual Ptr< Node >	GetPgwNode ()

virtual Ipv4Address	GetUeDefaultGatewayAddress ()

virtual Ipv6Address	GetUeDefaultGatewayAddress6 ()

Public Member Functions inherited from ns3::EpcHelper
	EpcHelper ()
	Constructor. More...

virtual	~EpcHelper ()
	Destructor. 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...

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...

SimpleRefCount &	operator= (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)
	Register this type. More...

Static Public Member Functions inherited from ns3::EpcHelper
static TypeId	GetTypeId (void)
	Register this type. 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...

Private Attributes
std::string	m_enbDeviceName
	The name of the device used for the S1-U interface of the eNB. More...

std::string	m_enbMacAddressBase
	First 5 bytes of the Enb MAC address base. More...

Ipv4AddressHelper	m_epcIpv4AddressHelper
	helper to assign addresses to S1-U NetDevices More...

uint16_t	m_gtpuUdpPort
	UDP port where the GTP-U Socket is bound, fixed by the standard as 2152. More...

std::map< uint64_t, Ptr< NetDevice > >	m_imsiEnbDeviceMap
	Map storing for each IMSI the corresponding eNB NetDevice. More...

Ptr< EpcMme >	m_mme
	MME network element. More...

std::string	m_sgwDeviceName
	The name of the device used for the S1-U interface of the SGW. More...

Ipv4InterfaceContainer	m_sgwIpIfaces
	Container for Ipv4Interfaces of the SGW/PGW. More...

std::string	m_sgwMacAddress
	MAC address used for the SGW. More...

Ptr< Node >	m_sgwPgw
	SGW-PGW network element. More...

Ptr< EpcSgwPgwApplication >	m_sgwPgwApp
	SGW-PGW application. More...

Ptr< VirtualNetDevice >	m_tunDevice
	TUN device containing IPv4 address and implementing tunneling of user data over GTP-U/UDP/IP. More...

Ipv4AddressHelper	m_uePgwAddressHelper
	helper to assign IPv4 addresses to UE devices as well as to the TUN device of the SGW/PGW More...

Ipv6AddressHelper	m_uePgwAddressHelper6
	helper to assign IPv6 addresses to UE devices as well as to the TUN device of the SGW/PGW More...

Additional Inherited Members
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...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

Create an EPC network using EmuFdNetDevice.

This Helper will create an EPC network topology comprising of a single node that implements both the SGW and PGW functionality, and an MME node. The S1-U, X2-U and X2-C interfaces are realized using EmuFdNetDevice; in particular, one device is used to send all the traffic related to these interfaces.

Definition at line 54 of file emu-epc-helper.h.

Constructor & Destructor Documentation

◆ EmuEpcHelper()

ns3::EmuEpcHelper::EmuEpcHelper ( )

Constructor.

Definition at line 60 of file emu-epc-helper.cc.

References ns3::ObjectBase::ConstructSelf(), and NS_LOG_FUNCTION.

◆ ~EmuEpcHelper()

ns3::EmuEpcHelper::~EmuEpcHelper ( )

virtual

Destructor.

Definition at line 68 of file emu-epc-helper.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ ActivateEpsBearer()

uint8_t ns3::EmuEpcHelper::ActivateEpsBearer	(	Ptr< NetDevice >	ueLteDevice,
		uint64_t	imsi,
		Ptr< EpcTft >	tft,
		EpsBearer	bearer
	)

virtual

Activate an EPS bearer, setting up the corresponding S1-U tunnel.

Parameters

ueLteDevice	the Ipv4-enabled device of the UE, normally connected via the LTE radio interface
imsi	the unique identifier of the UE
tft	the Traffic Flow Template of the new bearer
bearer	struct describing the characteristics of the EPS bearer to be activated

Returns: bearer ID

Implements ns3::EpcHelper.

Definition at line 361 of file emu-epc-helper.cc.

References ns3::EpcUeNas::ActivateEpsBearer(), ns3::Object::GetObject(), m_mme, m_sgwPgwApp, NS_ASSERT_MSG(), NS_LOG_FUNCTION, NS_LOG_LOGIC(), and ns3::Simulator::ScheduleNow().

◆ AddEnb()

void ns3::EmuEpcHelper::AddEnb	(	Ptr< Node >	enbNode,
		Ptr< NetDevice >	lteEnbNetDevice,
		uint16_t	cellId
	)

virtual

Add an eNB to the EPC.

Parameters

enbNode	the previously created eNB node which is to be added to the EPC
lteEnbNetDevice	the LteEnbNetDevice of the eNB node
cellId	ID of the eNB

Implements ns3::EpcHelper.

Definition at line 210 of file emu-epc-helper.cc.

References ns3::Node::AddApplication(), ns3::Object::AggregateObject(), ns3::Ipv4AddressHelper::Assign(), ns3::Socket::Bind(), ns3::Socket::Connect(), ns3::Socket::CreateSocket(), ns3::NetDeviceContainer::Get(), ns3::Ipv4InterfaceContainer::GetAddress(), ns3::Node::GetApplication(), ns3::Mac48Address::GetBroadcast(), ns3::Node::GetNApplications(), ns3::Ipv4::GetNInterfaces(), ns3::Object::GetObject(), ns3::Object::Initialize(), ns3::InternetStackHelper::Install(), ns3::TypeId::LookupByName(), m_enbDeviceName, m_enbMacAddressBase, m_epcIpv4AddressHelper, m_gtpuUdpPort, m_mme, m_sgwIpIfaces, m_sgwPgwApp, NS_ABORT_IF, NS_ASSERT, NS_ASSERT_MSG(), NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC(), ns3::Ipv6L3Protocol::PROT_NUMBER, ns3::Ipv4L3Protocol::PROT_NUMBER, ns3::PacketSocketAddress::SetPhysicalAddress(), ns3::PacketSocketAddress::SetProtocol(), and ns3::PacketSocketAddress::SetSingleDevice().

◆ AddUe()

void ns3::EmuEpcHelper::AddUe	(	Ptr< NetDevice >	ueLteDevice,
		uint64_t	imsi
	)

virtual

Notify the EPC of the existence of a new UE which might attach at a later time.

Parameters

ueLteDevice	the UE device to be attached
imsi	the unique identifier of the UE

Implements ns3::EpcHelper.

Definition at line 350 of file emu-epc-helper.cc.

References m_mme, m_sgwPgwApp, and NS_LOG_FUNCTION.

◆ AddX2Interface()

void ns3::EmuEpcHelper::AddX2Interface	(	Ptr< Node >	enbNode1,
		Ptr< Node >	enbNode2
	)

virtual

Add an X2 interface between two eNB.

Parameters

enbNode1	one eNB peer of the X2 interface
enbNode2	the other eNB peer of the X2 interface

Implements ns3::EpcHelper.

Definition at line 300 of file emu-epc-helper.cc.

References ns3::LteEnbNetDevice::GetCellId(), ns3::Node::GetDevice(), ns3::Node::GetNDevices(), ns3::Object::GetObject(), NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_LOGIC(), and NS_LOG_WARN.

◆ AssignUeIpv4Address()

Ipv4InterfaceContainer ns3::EmuEpcHelper::AssignUeIpv4Address ( NetDeviceContainer ueDevices )

virtual

Assign IPv4 addresses to UE devices.

Parameters

ueDevices the set of UE devices

Returns: the interface container,

See also: Ipv4AddressHelper::Assign() which has similar semantics

Implements ns3::EpcHelper.

Definition at line 412 of file emu-epc-helper.cc.

References ns3::Ipv4AddressHelper::Assign(), and m_uePgwAddressHelper.

Referenced by DoInitialize().

◆ AssignUeIpv6Address()

Ipv6InterfaceContainer ns3::EmuEpcHelper::AssignUeIpv6Address ( NetDeviceContainer ueDevices )

virtual

Assign IPv6 addresses to UE devices.

Parameters

ueDevices the set of UE devices

Returns: the interface container,

See also: Ipv6AddressHelper::Assign() which has similar semantics

Implements ns3::EpcHelper.

Definition at line 418 of file emu-epc-helper.cc.

References ns3::Ipv6AddressHelper::Assign(), ns3::NetDeviceContainer::Begin(), ns3::NetDeviceContainer::End(), and m_uePgwAddressHelper6.

Referenced by DoInitialize().

◆ DoDispose()

void ns3::EmuEpcHelper::DoDispose ( void )

virtual

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 overridden 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::EpcHelper.

Definition at line 199 of file emu-epc-helper.cc.

References ns3::Object::Dispose(), m_sgwPgw, m_sgwPgwApp, m_tunDevice, ns3::MakeNullCallback(), NS_LOG_FUNCTION, and ns3::VirtualNetDevice::SetSendCallback().

◆ DoInitialize()

void ns3::EmuEpcHelper::DoInitialize ( void )

virtual

Initialize() implementation.

This method is called only once by Initialize(). If the user calls Initialize() multiple times, DoInitialize() is called only the first time.

Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject() and AggregateObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 111 of file emu-epc-helper.cc.

References ns3::NetDeviceContainer::Add(), ns3::Node::AddApplication(), ns3::Node::AddDevice(), ns3::Mac48Address::Allocate(), ns3::Ipv4AddressHelper::Assign(), AssignUeIpv4Address(), AssignUeIpv6Address(), ns3::Socket::Bind(), ns3::Socket::CreateSocket(), ns3::Object::DoInitialize(), ns3::NetDeviceContainer::Get(), ns3::Ipv4Address::GetAny(), ns3::Object::GetObject(), ns3::Ipv6StaticRoutingHelper::GetStaticRouting(), ns3::FdNetDeviceHelper::Install(), ns3::InternetStackHelper::Install(), ns3::TypeId::LookupByName(), m_epcIpv4AddressHelper, m_gtpuUdpPort, m_mme, m_sgwDeviceName, m_sgwIpIfaces, m_sgwMacAddress, m_sgwPgw, m_sgwPgwApp, m_tunDevice, m_uePgwAddressHelper, m_uePgwAddressHelper6, ns3::MakeCallback(), NS_ASSERT, NS_LOG_LOGIC(), ns3::EpcSgwPgwApplication::RecvFromTunDevice(), ns3::VirtualNetDevice::SetAddress(), ns3::ObjectBase::SetAttribute(), ns3::Ipv4AddressHelper::SetBase(), ns3::Ipv6AddressHelper::SetBase(), ns3::Ipv6InterfaceContainer::SetDefaultRouteInAllNodes(), ns3::EmuFdNetDeviceHelper::SetDeviceName(), ns3::Ipv6InterfaceContainer::SetForwarding(), and ns3::VirtualNetDevice::SetSendCallback().

◆ GetInstanceTypeId()

TypeId ns3::EmuEpcHelper::GetInstanceTypeId ( ) const

virtual

Get the most derived TypeId for this Object.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Returns: The TypeId associated to the most-derived type of this instance.

Reimplemented from ns3::Object.

Definition at line 105 of file emu-epc-helper.cc.

References GetTypeId().

◆ GetPgwNode()

Ptr< Node > ns3::EmuEpcHelper::GetPgwNode ( )

virtual

Returns: a pointer to the node implementing PGW functionality. Note that in this particular implementation this node will also hold the SGW functionality. The primary use intended for this method is to allow the user to configure the Gi interface of the PGW, i.e., to connect the PGW to the internet.

Implements ns3::EpcHelper.

Definition at line 405 of file emu-epc-helper.cc.

References m_sgwPgw.

◆ GetTypeId()

TypeId ns3::EmuEpcHelper::GetTypeId ( void )

static

Register this type.

Returns: The object TypeId.

Definition at line 74 of file emu-epc-helper.cc.

References m_enbDeviceName, m_enbMacAddressBase, m_sgwDeviceName, m_sgwMacAddress, ns3::MakeStringAccessor(), ns3::MakeStringChecker(), and ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

◆ GetUeDefaultGatewayAddress()

Ipv4Address ns3::EmuEpcHelper::GetUeDefaultGatewayAddress ( )

virtual

Returns: the IPv4 address of the Default Gateway to be used by UEs to reach the internet

Implements ns3::EpcHelper.

Definition at line 431 of file emu-epc-helper.cc.

References ns3::Object::GetObject(), and m_sgwPgw.

◆ GetUeDefaultGatewayAddress6()

Ipv6Address ns3::EmuEpcHelper::GetUeDefaultGatewayAddress6 ( )

virtual

Returns: the IPv6 address of the Default Gateway to be used by UEs to reach the internet

Implements ns3::EpcHelper.

Definition at line 438 of file emu-epc-helper.cc.

References ns3::Ipv6::GetAddress(), ns3::Object::GetObject(), and m_sgwPgw.

Member Data Documentation

◆ m_enbDeviceName

std::string ns3::EmuEpcHelper::m_enbDeviceName

private

The name of the device used for the S1-U interface of the eNB.

Definition at line 151 of file emu-epc-helper.h.

Referenced by AddEnb(), and GetTypeId().

◆ m_enbMacAddressBase

std::string ns3::EmuEpcHelper::m_enbMacAddressBase

private

First 5 bytes of the Enb MAC address base.

Definition at line 161 of file emu-epc-helper.h.

Referenced by AddEnb(), and GetTypeId().

◆ m_epcIpv4AddressHelper

Ipv4AddressHelper ns3::EmuEpcHelper::m_epcIpv4AddressHelper

private

helper to assign addresses to S1-U NetDevices

Definition at line 125 of file emu-epc-helper.h.

Referenced by AddEnb(), and DoInitialize().

◆ m_gtpuUdpPort

uint16_t ns3::EmuEpcHelper::m_gtpuUdpPort

private

UDP port where the GTP-U Socket is bound, fixed by the standard as 2152.

Definition at line 130 of file emu-epc-helper.h.

Referenced by AddEnb(), and DoInitialize().

◆ m_imsiEnbDeviceMap

std::map<uint64_t, Ptr<NetDevice> > ns3::EmuEpcHelper::m_imsiEnbDeviceMap

private

Map storing for each IMSI the corresponding eNB NetDevice.

Definition at line 136 of file emu-epc-helper.h.

◆ m_mme

Ptr<EpcMme> ns3::EmuEpcHelper::m_mme

private

MME network element.

Definition at line 120 of file emu-epc-helper.h.

Referenced by ActivateEpsBearer(), AddEnb(), AddUe(), and DoInitialize().

◆ m_sgwDeviceName

std::string ns3::EmuEpcHelper::m_sgwDeviceName

private

The name of the device used for the S1-U interface of the SGW.

Definition at line 146 of file emu-epc-helper.h.

Referenced by DoInitialize(), and GetTypeId().

◆ m_sgwIpIfaces

Ipv4InterfaceContainer ns3::EmuEpcHelper::m_sgwIpIfaces

private

Container for Ipv4Interfaces of the SGW/PGW.

Definition at line 141 of file emu-epc-helper.h.

Referenced by AddEnb(), and DoInitialize().

◆ m_sgwMacAddress

std::string ns3::EmuEpcHelper::m_sgwMacAddress

private

MAC address used for the SGW.

Definition at line 156 of file emu-epc-helper.h.

Referenced by DoInitialize(), and GetTypeId().

◆ m_sgwPgw

Ptr<Node> ns3::EmuEpcHelper::m_sgwPgw

private

SGW-PGW network element.

Definition at line 105 of file emu-epc-helper.h.

Referenced by DoDispose(), DoInitialize(), GetPgwNode(), GetUeDefaultGatewayAddress(), and GetUeDefaultGatewayAddress6().

◆ m_sgwPgwApp

Ptr<EpcSgwPgwApplication> ns3::EmuEpcHelper::m_sgwPgwApp

private

SGW-PGW application.

Definition at line 110 of file emu-epc-helper.h.

Referenced by ActivateEpsBearer(), AddEnb(), AddUe(), DoDispose(), and DoInitialize().

◆ m_tunDevice

Ptr<VirtualNetDevice> ns3::EmuEpcHelper::m_tunDevice

private

TUN device containing IPv4 address and implementing tunneling of user data over GTP-U/UDP/IP.

Definition at line 115 of file emu-epc-helper.h.

Referenced by DoDispose(), and DoInitialize().

◆ m_uePgwAddressHelper

Ipv4AddressHelper ns3::EmuEpcHelper::m_uePgwAddressHelper

private

helper to assign IPv4 addresses to UE devices as well as to the TUN device of the SGW/PGW

Definition at line 95 of file emu-epc-helper.h.

Referenced by AssignUeIpv4Address(), and DoInitialize().

◆ m_uePgwAddressHelper6

Ipv6AddressHelper ns3::EmuEpcHelper::m_uePgwAddressHelper6

private

helper to assign IPv6 addresses to UE devices as well as to the TUN device of the SGW/PGW

Definition at line 100 of file emu-epc-helper.h.

Referenced by AssignUeIpv6Address(), and DoInitialize().

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

src/lte/helper/emu-epc-helper.h
src/lte/helper/emu-epc-helper.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EmuEpcHelper()

◆ ~EmuEpcHelper()

Member Function Documentation

◆ ActivateEpsBearer()

◆ AddEnb()

◆ AddUe()

◆ AddX2Interface()

◆ AssignUeIpv4Address()

◆ AssignUeIpv6Address()

◆ DoDispose()

◆ DoInitialize()

◆ GetInstanceTypeId()

◆ GetPgwNode()

◆ GetTypeId()

◆ GetUeDefaultGatewayAddress()

◆ GetUeDefaultGatewayAddress6()

Member Data Documentation

◆ m_enbDeviceName

◆ m_enbMacAddressBase

◆ m_epcIpv4AddressHelper

◆ m_gtpuUdpPort

◆ m_imsiEnbDeviceMap

◆ m_mme

◆ m_sgwDeviceName

◆ m_sgwIpIfaces

◆ m_sgwMacAddress

◆ m_sgwPgw

◆ m_sgwPgwApp

◆ m_tunDevice

◆ m_uePgwAddressHelper

◆ m_uePgwAddressHelper6