#include <lte-enb-rrc.h>

Inheritance diagram for ns3::LteEnbRrc:

Classes
struct	X2uTeidInfo

Public Types
enum	LteEpsBearerToRlcMapping_t { RLC_SM_ALWAYS = 1, RLC_UM_ALWAYS = 2, RLC_AM_ALWAYS = 3, PER_BASED = 4 }

Public Member Functions
	LteEnbRrc ()

virtual	~LteEnbRrc ()

void	ConfigureCell (uint8_t ulBandwidth, uint8_t dlBandwidth, uint16_t ulEarfcn, uint16_t dlEarfcn, uint16_t cellId)

void	ConnectionTimeout (uint16_t rnti)

EpcX2SapUser *	GetEpcX2SapUser ()

LteEnbCmacSapUser *	GetLteEnbCmacSapUser ()

LteEnbCphySapUser *	GetLteEnbCphySapUser ()

LteEnbRrcSapProvider *	GetLteEnbRrcSapProvider ()

EpcEnbS1SapUser *	GetS1SapUser ()

uint32_t	GetSrsPeriodicity () const

Ptr< UeManager >	GetUeManager (uint16_t rnti)

bool	SendData (Ptr< Packet > p)

void	SendHandoverRequest (uint16_t rnti, uint16_t cellId)

void	SetCellId (uint16_t m_cellId)

void	SetEpcX2SapProvider (EpcX2SapProvider *s)

void	SetForwardUpCallback (Callback< void, Ptr< Packet > > cb)

void	SetLteEnbCmacSapProvider (LteEnbCmacSapProvider *s)

void	SetLteEnbCphySapProvider (LteEnbCphySapProvider *s)

void	SetLteEnbRrcSapUser (LteEnbRrcSapUser *s)

void	SetLteMacSapProvider (LteMacSapProvider *s)

void	SetS1SapProvider (EpcEnbS1SapProvider *s)

void	SetSrsPeriodicity (uint32_t p)

Public Member Functions inherited from ns3::Object
void	AggregateObject (Ptr< Object > other)

void	Dispose (void)

AggregateIterator	GetAggregateIterator (void) const

virtual TypeId	GetInstanceTypeId (void) const

template<typename T >
Ptr< T >	GetObject (void) const

template<typename T >
Ptr< T >	GetObject (TypeId tid) const

void	Initialize (void)

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount (const SimpleRefCount &o)

uint32_t	GetReferenceCount (void) const

SimpleRefCount &	operator= (const SimpleRefCount &o)

void	Ref (void) const

void	Unref (void) const

Public Member Functions inherited from ns3::ObjectBase
void	GetAttribute (std::string name, AttributeValue &value) const

bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const

void	SetAttribute (std::string name, const AttributeValue &value)

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)

Protected Member Functions
virtual void	DoDispose (void)

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)

virtual void	DoInitialize (void)

virtual void	NotifyNewAggregate (void)

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)

Private Member Functions
uint16_t	AddUe (UeManager::State state)

uint16_t	DoAllocateTemporaryCellRnti ()

void	DoCompleteSetupUe (uint16_t rnti, LteEnbRrcSapProvider::CompleteSetupUeParameters params)

void	DoDataRadioBearerSetupRequest (EpcEnbS1SapUser::DataRadioBearerSetupRequestParameters params)

void	DoNotifyLcConfigResult (uint16_t rnti, uint8_t lcid, bool success)

void	DoPathSwitchRequestAcknowledge (EpcEnbS1SapUser::PathSwitchRequestAcknowledgeParameters params)

void	DoRecvHandoverPreparationFailure (EpcX2SapUser::HandoverPreparationFailureParams params)

void	DoRecvHandoverRequest (EpcX2SapUser::HandoverRequestParams params)

void	DoRecvHandoverRequestAck (EpcX2SapUser::HandoverRequestAckParams params)

void	DoRecvLoadInformation (EpcX2SapUser::LoadInformationParams params)

void	DoRecvMeasurementReport (uint16_t rnti, LteRrcSap::MeasurementReport msg)

void	DoRecvResourceStatusUpdate (EpcX2SapUser::ResourceStatusUpdateParams params)

void	DoRecvRrcConnectionReconfigurationCompleted (uint16_t rnti, LteRrcSap::RrcConnectionReconfigurationCompleted msg)

void	DoRecvRrcConnectionReestablishmentComplete (uint16_t rnti, LteRrcSap::RrcConnectionReestablishmentComplete msg)

void	DoRecvRrcConnectionReestablishmentRequest (uint16_t rnti, LteRrcSap::RrcConnectionReestablishmentRequest msg)

void	DoRecvRrcConnectionRequest (uint16_t rnti, LteRrcSap::RrcConnectionRequest msg)

void	DoRecvRrcConnectionSetupCompleted (uint16_t rnti, LteRrcSap::RrcConnectionSetupCompleted msg)

void	DoRecvSnStatusTransfer (EpcX2SapUser::SnStatusTransferParams params)

void	DoRecvUeContextRelease (EpcX2SapUser::UeContextReleaseParams params)

void	DoRecvUeData (EpcX2SapUser::UeDataParams params)

void	DoRrcConfigurationUpdateInd (LteEnbCmacSapUser::UeConfig params)

uint8_t	GetLogicalChannelGroup (EpsBearer bearer)

uint8_t	GetLogicalChannelPriority (EpsBearer bearer)

uint16_t	GetNewSrsConfigurationIndex (void)

TypeId	GetRlcType (EpsBearer bearer)

void	RemoveSrsConfigurationIndex (uint16_t srcCi)

void	RemoveUe (uint16_t rnti)

void	SendSystemInformation ()

Private Attributes
bool	m_admitHandoverRequest

bool	m_admitRrcConnectionRequest

uint16_t	m_cellId

LteEnbCmacSapProvider *	m_cmacSapProvider

LteEnbCmacSapUser *	m_cmacSapUser

bool	m_configured

TracedCallback< uint64_t, uint16_t, uint16_t >	m_connectionEstablishedTrace

TracedCallback< uint64_t, uint16_t, uint16_t >	m_connectionReconfigurationTrace

LteEnbCphySapProvider *	m_cphySapProvider

LteEnbCphySapUser *	m_cphySapUser

uint8_t	m_defaultTransmissionMode

uint16_t	m_dlBandwidth

uint16_t	m_dlEarfcn

enum LteEpsBearerToRlcMapping_t	m_epsBearerToRlcMapping

Callback< void, Ptr< Packet > >	m_forwardUpCallback

TracedCallback< uint64_t, uint16_t, uint16_t >	m_handoverEndOkTrace

TracedCallback< uint64_t, uint16_t, uint16_t, uint16_t >	m_handoverStartTrace

uint16_t	m_lastAllocatedConfigurationIndex

uint16_t	m_lastAllocatedRnti

LteMacSapProvider *	m_macSapProvider

TracedCallback< uint16_t, uint16_t >	m_newUeContextTrace

bool	m_reconfigureUes

LteEnbRrcSapProvider *	m_rrcSapProvider

LteEnbRrcSapUser *	m_rrcSapUser

EpcEnbS1SapProvider *	m_s1SapProvider

EpcEnbS1SapUser *	m_s1SapUser

uint16_t	m_srsCurrentPeriodicityId

Time	m_systemInformationPeriodicity

std::map< uint16_t, Ptr < UeManager > >	m_ueMap

std::set< uint16_t >	m_ueSrsConfigurationIndexSet

uint16_t	m_ulBandwidth

uint16_t	m_ulEarfcn

EpcX2SapProvider *	m_x2SapProvider

EpcX2SapUser *	m_x2SapUser

std::map< uint32_t, X2uTeidInfo >	m_x2uTeidInfoMap

Friends
class	EnbRrcMemberLteEnbCmacSapUser

class	EpcX2SpecificEpcX2SapUser< LteEnbRrc >

class	MemberEpcEnbS1SapUser< LteEnbRrc >

class	MemberLteEnbRrcSapProvider< LteEnbRrc >

class	UeManager

Detailed Description

The LTE Radio Resource Control entity at the eNB

Config Paths

ns3::LteEnbRrc is accessible through the following paths with Config::Set and Config::Connect:

/NodeList/[i]/DeviceList/[i]/$ns3::LteEnbNetDevice/LteEnbRrc
/NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteEnbNetDevice/LteEnbRrc

Attributes

UeMap: List of UeManager by C-RNTI.
- Set with class: ns3::ObjectPtrContainerValue
- Underlying type: ns3::Ptr< ns3::UeManager >
- Flags: read
DefaultTransmissionMode: The default UEs' transmission mode (0: SISO)
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 0
- Flags: construct write read
EpsBearerToRlcMapping: Specify which type of RLC will be used for each type of EPS bearer.
- Set with class: ns3::EnumValue
- Underlying type: RlcSmAlways|RlcUmAlways|RlcAmAlways|PacketErrorRateBased
- Initial value: RlcSmAlways
- Flags: construct write read
SystemInformationPeriodicity: The interval for sending system information (Time value)
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +80000000.0ns
- Flags: construct write read
SrsPeriodicity: The SRS periodicity in milliseconds
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 40
- Flags: construct write read
AdmitHandoverRequest: Whether to admit an X2 handover request from another eNB
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: construct write read
AdmitRrcConnectionRequest: Whether to admit a connection request from a Ue
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: construct write read

TraceSources

NewUeContext: trace fired upon creation of a new UE context
ConnectionEstablished: trace fired upon successful RRC connection establishment
ConnectionReconfiguration: trace fired upon RRC connection reconfiguration
HandoverStart: trace fired upon start of a handover procedure
HandoverEndOk: trace fired upon successful termination of a handover procedure

Definition at line 403 of file lte-enb-rrc.h.

Member Enumeration Documentation

enum ns3::LteEnbRrc::LteEpsBearerToRlcMapping_t

Identifies how EPS Bearer parameters are mapped to different RLC types

Definition at line 585 of file lte-enb-rrc.h.

Constructor & Destructor Documentation

ns3::LteEnbRrc::LteEnbRrc ( )

create an RRC instance for use within an eNB

Definition at line 1160 of file lte-enb-rrc.cc.

References NS_LOG_FUNCTION.

ns3::LteEnbRrc::~LteEnbRrc ( )

virtual

Destructor

Definition at line 1184 of file lte-enb-rrc.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

uint16_t ns3::LteEnbRrc::AddUe ( UeManager::State state )

private

Allocate a new RNTI for a new UE. This is done in the following cases:

T-C-RNTI allocation upon contention-based MAC Random Access procedure
target cell RNTI allocation upon handover

Parameters

state the initial state of the UeManager

Returns: the newly allocated RNTI

Definition at line 1714 of file lte-enb-rrc.cc.

References NS_ASSERT_MSG, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

void ns3::LteEnbRrc::ConfigureCell	(	uint8_t	ulBandwidth,
		uint8_t	dlBandwidth,
		uint16_t	ulEarfcn,
		uint16_t	dlEarfcn,
		uint16_t	cellId
	)

configure cell-specific parameters

Parameters

ulBandwidth	the uplink bandwidth in number of RB
dlBandwidth	the downlink bandwidth in number of RB
ulEarfcn	the UL EARFCN
dlEarfcn	the DL EARFCN
cellId	the ID of the cell

Definition at line 1353 of file lte-enb-rrc.cc.

References ns3::LteEnbCmacSapProvider::ConfigureMac(), ns3::MilliSeconds(), NS_ASSERT, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), SendSystemInformation(), ns3::LteEnbCphySapProvider::SetBandwidth(), ns3::LteEnbCphySapProvider::SetCellId(), ns3::LteEnbCphySapProvider::SetEarfcn(), and ns3::LteEnbCphySapProvider::SetMasterInformationBlock().

void ns3::LteEnbRrc::ConnectionTimeout ( uint16_t rnti )

Method triggered when a UE is expected to get connected but does not do so in a reasonable time

Parameters

rnti	the T-C-RNTI whose timeout expired

Definition at line 1403 of file lte-enb-rrc.cc.

References NS_LOG_FUNCTION, and RemoveUe().

Referenced by ns3::UeManager::DoInitialize().

void ns3::LteEnbRrc::DoDispose ( void )

protectedvirtual

This method is called by Object::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::Object.

Definition at line 1191 of file lte-enb-rrc.cc.

References NS_LOG_FUNCTION.

EpcX2SapUser * ns3::LteEnbRrc::GetEpcX2SapUser ( )

Get the X2 SAP offered by this RRC

Returns: s the X2 SAP User interface offered to the X2 entity by this RRC entity

Definition at line 1274 of file lte-enb-rrc.cc.

References NS_LOG_FUNCTION.

uint8_t ns3::LteEnbRrc::GetLogicalChannelGroup ( EpsBearer bearer )

private

Parameters

bearer the characteristics of the bearer

Returns: the Logical Channel Group in a bearer with these characteristics is put. Used for MAC Buffer Status Reporting purposes.

Definition at line 1896 of file lte-enb-rrc.cc.

References ns3::EpsBearer::IsGbr().

uint8_t ns3::LteEnbRrc::GetLogicalChannelPriority ( EpsBearer bearer )

private

Parameters

bearer the characteristics of the bearer

Returns: the priority level of a bearer with these characteristics is put. Used for the part of UL MAC Scheduling carried out by the UE

Definition at line 1909 of file lte-enb-rrc.cc.

LteEnbCmacSapUser * ns3::LteEnbRrc::GetLteEnbCmacSapUser ( )

Get the CMAC SAP offered by this RRC

Returns: s the CMAC SAP User interface offered to the MAC by this RRC

Definition at line 1288 of file lte-enb-rrc.cc.

References NS_LOG_FUNCTION.

LteEnbCphySapUser * ns3::LteEnbRrc::GetLteEnbCphySapUser ( )

Returns: s the CPHY SAP User interface offered to the PHY by this RRC

Definition at line 1336 of file lte-enb-rrc.cc.

References NS_LOG_FUNCTION.

LteEnbRrcSapProvider * ns3::LteEnbRrc::GetLteEnbRrcSapProvider ( )

Returns: s the RRC SAP Provider interface offered to the MAC by this RRC

Definition at line 1302 of file lte-enb-rrc.cc.

References NS_LOG_FUNCTION.

uint16_t ns3::LteEnbRrc::GetNewSrsConfigurationIndex ( void )

private

Allocate a new SRS configuration index for a new UE.

Note: this method can have the side effect of updating the SRS configuration index of all UEs

Returns: the newly allocated SRS configuration index

Definition at line 1833 of file lte-enb-rrc.cc.

References NS_ASSERT, NS_FATAL_ERROR, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

TypeId ns3::LteEnbRrc::GetRlcType ( EpsBearer bearer )

private

Parameters

bearer the specification of an EPS bearer

Returns: the type of RLC that is to be created for the given EPS bearer

Definition at line 1759 of file lte-enb-rrc.cc.

References ns3::EpsBearer::GetPacketErrorLossRate().

EpcEnbS1SapUser * ns3::LteEnbRrc::GetS1SapUser ( )

Returns: the S1 SAP user

Definition at line 1323 of file lte-enb-rrc.cc.

uint32_t ns3::LteEnbRrc::GetSrsPeriodicity ( ) const

Returns: the current SRS periodicity

Definition at line 1823 of file lte-enb-rrc.cc.

References NS_ASSERT, and NS_LOG_FUNCTION.

Ptr< UeManager > ns3::LteEnbRrc::GetUeManager ( uint16_t rnti )

Parameters

rnti	the identifier of an UE

Returns: the corresponding UeManager instance

Definition at line 1343 of file lte-enb-rrc.cc.

References NS_ASSERT, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Referenced by SendData(), and SendHandoverRequest().

void ns3::LteEnbRrc::RemoveSrsConfigurationIndex ( uint16_t srcCi )

private

remove a previously allocated SRS configuration index

Note: this method can have the side effect of updating the SRS configuration index of all UEs

Parameters

srcCi the indext to be removed

Definition at line 1887 of file lte-enb-rrc.cc.

References NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Referenced by RemoveUe().

void ns3::LteEnbRrc::RemoveUe ( uint16_t rnti )

private

remove a UE from the cell

Parameters

rnti	the C-RNTI identiftying the user

Definition at line 1741 of file lte-enb-rrc.cc.

References NS_ASSERT_MSG, NS_LOG_FUNCTION, RemoveSrsConfigurationIndex(), ns3::LteEnbCmacSapProvider::RemoveUe(), ns3::LteEnbCphySapProvider::RemoveUe(), and ns3::EpcEnbS1SapProvider::UeContextRelease().

Referenced by ConnectionTimeout().

bool ns3::LteEnbRrc::SendData ( Ptr< Packet > p )

Enqueue an IP data packet on the proper bearer for downlink transmission. Normally expected to be called by the NetDevice forwarding a packet coming from the EpcEnbApplication

Parameters

p	the packet

Returns: true if successful, false if an error occurred

Definition at line 1383 of file lte-enb-rrc.cc.

References GetUeManager(), NS_ASSERT_MSG, NS_LOG_FUNCTION, and ns3::Packet::RemovePacketTag().

void ns3::LteEnbRrc::SendHandoverRequest	(	uint16_t	rnti,
		uint16_t	cellId
	)

Send a HandoverRequest through the X2 SAP interface

This method will trigger a handover which is started by the RRC by sending a handover request to the target eNB over the X2 interface

Parameters

imsi	the id of the UE to be handed over
cellId	the id of the target eNB

Definition at line 1411 of file lte-enb-rrc.cc.

References GetUeManager(), NS_ASSERT, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

void ns3::LteEnbRrc::SendSystemInformation ( )

private

method used to periodically send System Information

Definition at line 1915 of file lte-enb-rrc.cc.

References ns3::LteEnbCmacSapProvider::GetRachConfig(), NS_LOG_FUNCTION, and ns3::Simulator::Schedule().

Referenced by ConfigureCell().

void ns3::LteEnbRrc::SetCellId ( uint16_t m_cellId )

set the cell id of this eNB

Parameters

m_cellId

Definition at line 1377 of file lte-enb-rrc.cc.

void ns3::LteEnbRrc::SetEpcX2SapProvider ( EpcX2SapProvider * s )

Set the X2 SAP this RRC should interact with

Parameters

s	the X2 SAP Provider to be used by this RRC entity

Definition at line 1267 of file lte-enb-rrc.cc.

References NS_LOG_FUNCTION.

void ns3::LteEnbRrc::SetForwardUpCallback ( Callback< void, Ptr< Packet > > cb )

set the callback used to forward data packets up the stack

Parameters

void
cb

Definition at line 1397 of file lte-enb-rrc.cc.

void ns3::LteEnbRrc::SetLteEnbCmacSapProvider ( LteEnbCmacSapProvider * s )

set the CMAC SAP this RRC should interact with

Parameters

s	the CMAC SAP Provider to be used by this RRC

Definition at line 1281 of file lte-enb-rrc.cc.

References NS_LOG_FUNCTION.

void ns3::LteEnbRrc::SetLteEnbCphySapProvider ( LteEnbCphySapProvider * s )

set the CPHY SAP this RRC should use to interact with the PHY

Parameters

s	the CPHY SAP Provider

Definition at line 1329 of file lte-enb-rrc.cc.

References NS_LOG_FUNCTION.

void ns3::LteEnbRrc::SetLteEnbRrcSapUser ( LteEnbRrcSapUser * s )

set the RRC SAP this RRC should interact with

Parameters

s	the RRC SAP User to be used by this RRC

Definition at line 1295 of file lte-enb-rrc.cc.

References NS_LOG_FUNCTION.

void ns3::LteEnbRrc::SetLteMacSapProvider ( LteMacSapProvider * s )

set the MAC SAP provider. The eNB RRC does not use this directly, but it needs to provide it to newly created RLC instances.

Parameters

s	the MAC SAP provider that will be used by all newly created RLC instances

Definition at line 1309 of file lte-enb-rrc.cc.

References NS_LOG_FUNCTION.

void ns3::LteEnbRrc::SetS1SapProvider ( EpcEnbS1SapProvider * s )

Set the S1 SAP Provider

Parameters

s	the S1 SAP Provider

Definition at line 1316 of file lte-enb-rrc.cc.

void ns3::LteEnbRrc::SetSrsPeriodicity ( uint32_t p )

Parameters

p	the SRS periodicity in num TTIs

Definition at line 1802 of file lte-enb-rrc.cc.

References NS_FATAL_ERROR, and NS_LOG_FUNCTION.

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

src/lte/model/lte-enb-rrc.h
src/lte/model/lte-enb-rrc.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Config Paths

Attributes

TraceSources

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation