LTE RLC Unacknowledged Mode (UM), see 3GPP TS 36.322. More...
#include "lte-rlc-um.h"
Classes | |
struct | TxPdu |
Store an incoming (from layer above us) PDU, waiting to transmit it. More... | |
Public Member Functions | |
LteRlcUm () | |
~LteRlcUm () override | |
void | DoDispose () override |
Destructor implementation. | |
void | DoNotifyHarqDeliveryFailure () override |
Notify HARQ delivery failure. | |
void | DoNotifyTxOpportunity (LteMacSapUser::TxOpportunityParameters txOpParams) override |
MAC SAP. | |
void | DoReceivePdu (LteMacSapUser::ReceivePduParameters rxPduParams) override |
Receive PDU function. | |
void | DoTransmitPdcpPdu (Ptr< Packet > p) override |
RLC SAP. | |
Public Member Functions inherited from ns3::LteRlc | |
LteRlc () | |
~LteRlc () override | |
LteMacSapUser * | GetLteMacSapUser () |
LteRlcSapProvider * | GetLteRlcSapProvider () |
void | SetLcId (uint8_t lcId) |
void | SetLteMacSapProvider (LteMacSapProvider *s) |
void | SetLteRlcSapUser (LteRlcSapUser *s) |
void | SetPacketDelayBudgetMs (uint16_t packetDelayBudget) |
void | SetRnti (uint16_t rnti) |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. | |
~Object () override | |
Destructor. | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. | |
void | Dispose () |
Dispose of this Object. | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. | |
bool | IsInitialized () const |
Check if the object has been initialized. | |
void | UnidirectionalAggregateObject (Ptr< Object > other) |
Aggregate an Object to another Object. | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Default constructor. | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment operator. | |
void | Ref () const |
Increment the reference count. | |
void | Unref () const |
Decrement the reference count. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::LteRlc | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Private Types | |
enum | ReassemblingState_t { NONE = 0 , WAITING_S0_FULL = 1 , WAITING_SI_SF = 2 } |
Reassembling state. More... | |
Private Member Functions | |
void | DoReportBufferStatus () |
Report buffer status. | |
void | ExpireRbsTimer () |
Expire RBS timer. | |
void | ExpireReorderingTimer () |
Expire reordering timer. | |
bool | IsInsideReorderingWindow (SequenceNumber10 seqNumber) |
Is inside reordering window function. | |
void | ReassembleAndDeliver (Ptr< Packet > packet) |
Reassemble and deliver function. | |
void | ReassembleOutsideWindow () |
Reassemble outside window. | |
void | ReassembleSnInterval (SequenceNumber10 lowSeqNumber, SequenceNumber10 highSeqNumber) |
Reassemble SN interval function. | |
Private Attributes | |
uint32_t | m_discardTimerMs {0} |
the discard timer value in milliseconds | |
bool | m_enablePdcpDiscarding {false} |
whether to use the PDCP discarding (perform discarding at the moment of passing the PDCP SDU to RLC) | |
SequenceNumber10 | m_expectedSeqNumber |
Expected Sequence Number. | |
Ptr< Packet > | m_keepS0 |
keep S0 | |
uint32_t | m_maxTxBufferSize |
maximum transmit buffer status | |
EventId | m_rbsTimer |
RBS timer. | |
std::vector< Ptr< Packet > > | m_reasBuffer |
Reassembling buffer. | |
ReassemblingState_t | m_reassemblingState |
reassembling state | |
EventId | m_reorderingTimer |
reordering timer | |
Time | m_reorderingTimerValue |
Timers. | |
std::map< uint16_t, Ptr< Packet > > | m_rxBuffer |
Reception buffer. | |
std::list< Ptr< Packet > > | m_sdusBuffer |
List of SDUs in a packet. | |
SequenceNumber10 | m_sequenceNumber |
State variables. | |
std::deque< TxPdu > | m_txBuffer |
Transmission buffer. | |
uint32_t | m_txBufferSize |
transmit buffer size | |
SequenceNumber10 | m_vrUh |
VR(UH) | |
SequenceNumber10 | m_vrUr |
VR(UR) | |
SequenceNumber10 | m_vrUx |
VR(UX) | |
uint16_t | m_windowSize |
Constants. | |
Additional Inherited Members | |
Public Types inherited from ns3::LteRlc | |
typedef void(* | NotifyTxTracedCallback) (uint16_t rnti, uint8_t lcid, uint32_t bytes) |
TracedCallback signature for NotifyTxOpportunity events. | |
typedef void(* | ReceiveTracedCallback) (uint16_t rnti, uint8_t lcid, uint32_t bytes, uint64_t delay) |
TracedCallback signature for. | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. | |
virtual void | DoInitialize () |
Initialize() implementation. | |
virtual void | NotifyNewAggregate () |
Notify all Objects aggregated to this one of a new Object being aggregated. | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Protected Attributes inherited from ns3::LteRlc | |
uint8_t | m_lcid |
LCID. | |
LteMacSapProvider * | m_macSapProvider |
MAC SAP provider. | |
LteMacSapUser * | m_macSapUser |
MAC SAP user. | |
uint16_t | m_packetDelayBudgetMs |
the packet delay budget in ms of the corresponding logical channel | |
LteRlcSapProvider * | m_rlcSapProvider |
RLC SAP provider. | |
LteRlcSapUser * | m_rlcSapUser |
RLC SAP user. | |
uint16_t | m_rnti |
RNTI. | |
TracedCallback< uint16_t, uint8_t, uint32_t, uint64_t > | m_rxPdu |
Used to inform of a PDU reception from the MAC SAP user. | |
TracedCallback< Ptr< const Packet > > | m_txDropTrace |
The trace source fired when the RLC drops a packet before transmission. | |
TracedCallback< uint16_t, uint8_t, uint32_t > | m_txPdu |
Used to inform of a PDU delivery to the MAC SAP provider. | |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
LTE RLC Unacknowledged Mode (UM), see 3GPP TS 36.322.
ns3::LteRlcUm is accessible through the following paths with Config::Set and Config::Connect:
Time
-9.22337e+18ns:+9.22337e+18ns No TraceSources are defined for this type.
Group: Lte
Size of this type is 464 bytes (on a 64-bit architecture).
Definition at line 26 of file lte-rlc-um.h.
|
private |
Reassembling state.
Enumerator | |
---|---|
NONE | |
WAITING_S0_FULL | |
WAITING_SI_SF |
Definition at line 147 of file lte-rlc-um.h.
ns3::LteRlcUm::LteRlcUm | ( | ) |
Definition at line 25 of file lte-rlc-um.cc.
References m_reassemblingState, NS_LOG_FUNCTION, and WAITING_S0_FULL.
|
override |
Definition at line 39 of file lte-rlc-um.cc.
References NS_LOG_FUNCTION.
|
overridevirtual |
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::LteRlc.
Definition at line 80 of file lte-rlc-um.cc.
References ns3::EventId::Cancel(), ns3::LteRlc::DoDispose(), m_rbsTimer, m_reorderingTimer, and NS_LOG_FUNCTION.
|
overridevirtual |
Notify HARQ delivery failure.
Implements ns3::LteRlc.
Definition at line 435 of file lte-rlc-um.cc.
References NS_LOG_FUNCTION.
|
overridevirtual |
MAC SAP.
txOpParams | the LteMacSapUser::TxOpportunityParameters |
Implements ns3::LteRlc.
Definition at line 152 of file lte-rlc-um.cc.
References ns3::LteMacSapUser::TxOpportunityParameters::bytes, ns3::EventId::Cancel(), ns3::LteMacSapUser::TxOpportunityParameters::componentCarrierId, ns3::Create(), ns3::LteRlcHeader::DATA_FIELD_FOLLOWS, ns3::LteRlcHeader::E_LI_FIELDS_FOLLOWS, ExpireRbsTimer(), ns3::LteRlcHeader::FIRST_BYTE, ns3::LteRlcSduStatusTag::FIRST_SEGMENT, ns3::LteRlcSduStatusTag::FULL_SDU, ns3::LteRlcHeader::GetSerializedSize(), ns3::LteRlcSduStatusTag::GetStatus(), ns3::LteMacSapUser::TxOpportunityParameters::harqId, ns3::LteRlcHeader::LAST_BYTE, ns3::LteRlcSduStatusTag::LAST_SEGMENT, ns3::LteMacSapUser::TxOpportunityParameters::layer, ns3::LteRlc::m_lcid, ns3::LteRlc::m_macSapProvider, m_rbsTimer, ns3::LteRlc::m_rnti, m_sequenceNumber, m_txBuffer, m_txBufferSize, ns3::LteRlc::m_txPdu, ns3::LteRlcSduStatusTag::MIDDLE_SEGMENT, ns3::MilliSeconds(), ns3::LteRlcHeader::NO_FIRST_BYTE, ns3::LteRlcHeader::NO_LAST_BYTE, ns3::Simulator::Now(), NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, ns3::LteRlcHeader::PushExtensionBit(), ns3::LteRlcHeader::PushLengthIndicator(), ns3::Simulator::Schedule(), ns3::LteRlcHeader::SetFramingInfo(), ns3::LteRlcHeader::SetSequenceNumber(), ns3::LteRlcSduStatusTag::SetStatus(), and ns3::LteMacSapProvider::TransmitPdu().
|
overridevirtual |
Receive PDU function.
params | the LteMacSapUser::ReceivePduParameters |
Implements ns3::LteRlc.
Definition at line 441 of file lte-rlc-um.cc.
References ns3::EventId::Cancel(), ExpireReorderingTimer(), ns3::Packet::FindFirstMatchingByteTag(), ns3::Time::GetNanoSeconds(), ns3::RlcTag::GetSenderTimestamp(), ns3::LteRlcHeader::GetSequenceNumber(), ns3::Packet::GetSize(), ns3::SequenceNumber10::GetValue(), IsInsideReorderingWindow(), ns3::EventId::IsPending(), ns3::LteRlc::m_lcid, m_reorderingTimer, m_reorderingTimerValue, ns3::LteRlc::m_rnti, m_rxBuffer, ns3::LteRlc::m_rxPdu, m_vrUh, m_vrUr, m_vrUx, m_windowSize, ns3::Simulator::Now(), NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::LteMacSapUser::ReceivePduParameters::p, ns3::Packet::PeekHeader(), ReassembleOutsideWindow(), ReassembleSnInterval(), ns3::Simulator::Schedule(), and ns3::SequenceNumber10::SetModulusBase().
|
private |
Report buffer status.
Definition at line 1165 of file lte-rlc-um.cc.
References ns3::Time::GetMilliSeconds(), ns3::LteMacSapProvider::ReportBufferStatusParameters::lcid, ns3::LteRlc::m_lcid, ns3::LteRlc::m_macSapProvider, ns3::LteRlc::m_rnti, m_txBuffer, m_txBufferSize, ns3::Simulator::Now(), NS_LOG_LOGIC, queueSize, ns3::LteMacSapProvider::ReportBufferStatus(), ns3::LteMacSapProvider::ReportBufferStatusParameters::retxQueueHolDelay, ns3::LteMacSapProvider::ReportBufferStatusParameters::retxQueueSize, ns3::LteMacSapProvider::ReportBufferStatusParameters::rnti, ns3::LteMacSapProvider::ReportBufferStatusParameters::statusPduSize, ns3::LteMacSapProvider::ReportBufferStatusParameters::txQueueHolDelay, and ns3::LteMacSapProvider::ReportBufferStatusParameters::txQueueSize.
Referenced by DoTransmitPdcpPdu(), and ExpireRbsTimer().
RLC SAP.
p | packet |
Store PDCP PDU
Report Buffer Status
Implements ns3::LteRlc.
Definition at line 94 of file lte-rlc-um.cc.
References ns3::EventId::Cancel(), DoReportBufferStatus(), ns3::LteRlcSduStatusTag::FULL_SDU, m_discardTimerMs, m_enablePdcpDiscarding, ns3::LteRlc::m_lcid, m_maxTxBufferSize, ns3::LteRlc::m_packetDelayBudgetMs, m_rbsTimer, ns3::LteRlc::m_rnti, m_txBuffer, m_txBufferSize, ns3::LteRlc::m_txDropTrace, ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, and ns3::LteRlcSduStatusTag::SetStatus().
|
private |
Expire RBS timer.
Definition at line 1231 of file lte-rlc-um.cc.
References DoReportBufferStatus(), ExpireRbsTimer(), m_rbsTimer, m_txBuffer, ns3::MilliSeconds(), NS_LOG_LOGIC, and ns3::Simulator::Schedule().
Referenced by DoNotifyTxOpportunity(), and ExpireRbsTimer().
|
private |
Expire reordering timer.
Definition at line 1192 of file lte-rlc-um.cc.
References ExpireReorderingTimer(), ns3::SequenceNumber10::GetValue(), ns3::LteRlc::m_lcid, m_reorderingTimer, m_reorderingTimerValue, ns3::LteRlc::m_rnti, m_rxBuffer, m_vrUh, m_vrUr, m_vrUx, NS_LOG_FUNCTION, NS_LOG_LOGIC, ReassembleSnInterval(), and ns3::Simulator::Schedule().
Referenced by DoReceivePdu(), and ExpireReorderingTimer().
|
static |
Get the type ID.
Definition at line 45 of file lte-rlc-um.cc.
References m_discardTimerMs, m_enablePdcpDiscarding, m_maxTxBufferSize, m_reorderingTimerValue, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), ns3::MilliSeconds(), and ns3::TypeId::SetParent().
Referenced by ns3::LteUeRrc::ApplyRadioResourceConfigDedicated(), and ns3::LteEnbRrc::GetRlcType().
|
private |
Is inside reordering window function.
seqNumber | the sequence number |
Definition at line 609 of file lte-rlc-um.cc.
References m_vrUh, m_windowSize, NS_LOG_FUNCTION, NS_LOG_LOGIC, and ns3::SequenceNumber10::SetModulusBase().
Referenced by DoReceivePdu(), and ReassembleOutsideWindow().
Reassemble and deliver function.
packet | the packet |
Deliver one or multiple PDUs
Deliver full PDUs
Keep S0
Discard SI or SN
Deliver zero, one or multiple PDUs
Discard SI or SN
Deliver zero, one or multiple PDUs
Keep S0
ERROR: Transition not possible
Deliver (Kept)S0 + SN
Deliver zero, one or multiple PDUs
Keep SI
Deliver (Kept)S0 + SN
Deliver zero, one or multiple PDUs
Keep S0
ERROR: Transition not possible
Deliver one or multiple PDUs
Deliver full PDUs
Keep S0
Discard SN
Deliver zero, one or multiple PDUs
Discard SI or SN
Deliver zero, one or multiple PDUs
Keep S0
ERROR: Transition not possible
Discard S0
Deliver one or multiple PDUs
Discard S0
Deliver zero, one or multiple PDUs
Keep S0
Discard S0
Discard SI or SN
Deliver zero, one or multiple PDUs
Discard S0
Discard SI or SN
Deliver zero, one or multiple PDUs
Keep S0
ERROR: Transition not possible
Definition at line 631 of file lte-rlc-um.cc.
References ns3::Packet::AddAtEnd(), ns3::LteRlcHeader::FIRST_BYTE, ns3::LteRlcHeader::GetFramingInfo(), ns3::LteRlcHeader::GetSequenceNumber(), ns3::LteRlcHeader::LAST_BYTE, m_expectedSeqNumber, m_keepS0, m_reassemblingState, ns3::LteRlc::m_rlcSapUser, m_sdusBuffer, ns3::LteRlcHeader::NO_FIRST_BYTE, ns3::LteRlcHeader::NO_LAST_BYTE, NS_LOG_LOGIC, ns3::LteRlcHeader::PopExtensionBit(), ns3::LteRlcHeader::PopLengthIndicator(), ns3::LteRlcSapUser::ReceivePdcpPdu(), WAITING_S0_FULL, and WAITING_SI_SF.
Referenced by ReassembleOutsideWindow(), and ReassembleSnInterval().
|
private |
Reassemble outside window.
Definition at line 1112 of file lte-rlc-um.cc.
References IsInsideReorderingWindow(), m_rxBuffer, NS_LOG_LOGIC, and ReassembleAndDeliver().
Referenced by DoReceivePdu().
|
private |
Reassemble SN interval function.
lowSeqNumber | the low sequence number |
highSeqNumber | the high sequence number |
Definition at line 1137 of file lte-rlc-um.cc.
References ns3::SequenceNumber10::GetValue(), m_rxBuffer, NS_LOG_LOGIC, and ReassembleAndDeliver().
Referenced by DoReceivePdu(), and ExpireReorderingTimer().
|
private |
the discard timer value in milliseconds
Definition at line 142 of file lte-rlc-um.h.
Referenced by DoTransmitPdcpPdu(), and GetTypeId().
|
private |
whether to use the PDCP discarding (perform discarding at the moment of passing the PDCP SDU to RLC)
Definition at line 140 of file lte-rlc-um.h.
Referenced by DoTransmitPdcpPdu(), and GetTypeId().
|
private |
Expected Sequence Number.
Definition at line 160 of file lte-rlc-um.h.
Referenced by ReassembleAndDeliver().
|
private |
maximum transmit buffer status
Definition at line 89 of file lte-rlc-um.h.
Referenced by DoTransmitPdcpPdu(), and GetTypeId().
|
private |
RBS timer.
Definition at line 139 of file lte-rlc-um.h.
Referenced by DoDispose(), DoNotifyTxOpportunity(), DoTransmitPdcpPdu(), and ExpireRbsTimer().
Reassembling buffer.
Definition at line 116 of file lte-rlc-um.h.
|
private |
reassembling state
Definition at line 154 of file lte-rlc-um.h.
Referenced by LteRlcUm(), and ReassembleAndDeliver().
|
private |
reordering timer
Definition at line 138 of file lte-rlc-um.h.
Referenced by DoDispose(), DoReceivePdu(), and ExpireReorderingTimer().
|
private |
Timers.
See section 7.3 in TS 36.322 reordering timer value
Definition at line 137 of file lte-rlc-um.h.
Referenced by DoReceivePdu(), ExpireReorderingTimer(), and GetTypeId().
Reception buffer.
Definition at line 115 of file lte-rlc-um.h.
Referenced by DoReceivePdu(), ExpireReorderingTimer(), ReassembleOutsideWindow(), and ReassembleSnInterval().
List of SDUs in a packet.
Definition at line 118 of file lte-rlc-um.h.
Referenced by ReassembleAndDeliver().
|
private |
State variables.
See section 7.1 in TS 36.322 VT(US)
Definition at line 123 of file lte-rlc-um.h.
Referenced by DoNotifyTxOpportunity().
|
private |
Transmission buffer.
Definition at line 114 of file lte-rlc-um.h.
Referenced by DoNotifyTxOpportunity(), DoReportBufferStatus(), DoTransmitPdcpPdu(), and ExpireRbsTimer().
|
private |
transmit buffer size
Definition at line 90 of file lte-rlc-um.h.
Referenced by DoNotifyTxOpportunity(), DoReportBufferStatus(), and DoTransmitPdcpPdu().
|
private |
VR(UH)
Definition at line 127 of file lte-rlc-um.h.
Referenced by DoReceivePdu(), ExpireReorderingTimer(), and IsInsideReorderingWindow().
|
private |
VR(UR)
Definition at line 125 of file lte-rlc-um.h.
Referenced by DoReceivePdu(), and ExpireReorderingTimer().
|
private |
VR(UX)
Definition at line 126 of file lte-rlc-um.h.
Referenced by DoReceivePdu(), and ExpireReorderingTimer().
|
private |
Constants.
See section 7.2 in TS 36.322 windows size
Definition at line 132 of file lte-rlc-um.h.
Referenced by DoReceivePdu(), and IsInsideReorderingWindow().