21 #include "ns3/simulator.h"
24 #include "ns3/lte-rlc-header.h"
25 #include "ns3/lte-rlc-um.h"
26 #include "ns3/lte-rlc-sdu-status-tag.h"
27 #include "ns3/lte-rlc-tag.h"
33 NS_OBJECT_ENSURE_REGISTERED (LteRlcUm);
36 : m_maxTxBufferSize (2 * 1024 * 1024),
43 m_expectedSeqNumber (0)
46 m_reassemblingState = WAITING_S0_FULL;
49 LteRlcUm::~LteRlcUm ()
55 LteRlcUm::GetTypeId (
void)
57 static TypeId tid = TypeId (
"ns3::LteRlcUm")
59 .AddConstructor<LteRlcUm> ()
60 .AddAttribute (
"MaxTxBufferSize",
61 "Maximum Size of the Transmission Buffer (in Bytes)",
62 UintegerValue (2 * 1024 * 1024),
63 MakeUintegerAccessor (&LteRlcUm::m_maxTxBufferSize),
64 MakeUintegerChecker<uint32_t> ())
88 if (m_txBufferSize + p->
GetSize () <= m_maxTxBufferSize)
97 tag.SetStatus (LteRlcSduStatusTag::FULL_SDU);
101 m_txBuffer.push_back (p);
102 m_txBufferSize += p->
GetSize ();
110 NS_LOG_LOGIC (
"MaxTxBufferSize = " << m_maxTxBufferSize);
116 DoReportBufferStatus ();
141 uint32_t nextSegmentSize = bytes - 2;
142 uint32_t nextSegmentId = 1;
143 uint32_t dataFieldTotalSize = 0;
144 uint32_t dataFieldAddedSize = 0;
145 std::vector < Ptr<Packet> > dataField;
149 if ( m_txBuffer.size () == 0 )
155 NS_LOG_LOGIC (
"SDUs in TxBuffer = " << m_txBuffer.size ());
156 NS_LOG_LOGIC (
"First SDU buffer = " << *(m_txBuffer.begin()));
157 NS_LOG_LOGIC (
"First SDU size = " << (*(m_txBuffer.begin()))->GetSize ());
158 NS_LOG_LOGIC (
"Next segment size = " << nextSegmentSize);
161 m_txBufferSize -= (*(m_txBuffer.begin()))->GetSize ();
163 m_txBuffer.erase (m_txBuffer.begin ());
165 while ( firstSegment && (firstSegment->
GetSize () > 0) && (nextSegmentSize > 0) )
167 NS_LOG_LOGIC (
"WHILE ( firstSegment && firstSegment->GetSize > 0 && nextSegmentSize > 0 )");
169 NS_LOG_LOGIC (
" nextSegmentSize = " << nextSegmentSize);
170 if ( (firstSegment->
GetSize () > nextSegmentSize) ||
172 (firstSegment->
GetSize () > 2047)
177 uint32_t currSegmentSize = std::min (firstSegment->
GetSize (), nextSegmentSize);
179 NS_LOG_LOGIC (
" IF ( firstSegment > nextSegmentSize ||");
193 if (oldTag.GetStatus () == LteRlcSduStatusTag::FULL_SDU)
195 newTag.SetStatus (LteRlcSduStatusTag::FIRST_SEGMENT);
196 oldTag.SetStatus (LteRlcSduStatusTag::LAST_SEGMENT);
198 else if (oldTag.GetStatus () == LteRlcSduStatusTag::LAST_SEGMENT)
200 newTag.SetStatus (LteRlcSduStatusTag::MIDDLE_SEGMENT);
207 if (firstSegment->
GetSize () > 0)
211 m_txBuffer.insert (m_txBuffer.begin (), firstSegment);
212 m_txBufferSize += (*(m_txBuffer.begin()))->GetSize ();
214 NS_LOG_LOGIC (
" TX buffer: Give back the remaining segment");
216 NS_LOG_LOGIC (
" Front buffer size = " << (*(m_txBuffer.begin()))->GetSize ());
222 if (newTag.GetStatus () == LteRlcSduStatusTag::FIRST_SEGMENT)
224 newTag.SetStatus (LteRlcSduStatusTag::FULL_SDU);
226 else if (newTag.GetStatus () == LteRlcSduStatusTag::MIDDLE_SEGMENT)
228 newTag.SetStatus (LteRlcSduStatusTag::LAST_SEGMENT);
239 dataFieldAddedSize = newSegment->
GetSize ();
240 dataFieldTotalSize += dataFieldAddedSize;
241 dataField.push_back (newSegment);
245 rlcHeader.PushExtensionBit (LteRlcHeader::DATA_FIELD_FOLLOWS);
249 nextSegmentSize -= dataFieldAddedSize;
257 else if ( (nextSegmentSize - firstSegment->
GetSize () <= 2) || (m_txBuffer.size () == 0) )
259 NS_LOG_LOGIC (
" IF nextSegmentSize - firstSegment->GetSize () <= 2 || txBuffer.size == 0");
261 dataFieldAddedSize = firstSegment->
GetSize ();
262 dataFieldTotalSize += dataFieldAddedSize;
263 dataField.push_back (firstSegment);
267 rlcHeader.PushExtensionBit (LteRlcHeader::DATA_FIELD_FOLLOWS);
271 nextSegmentSize -= dataFieldAddedSize;
274 NS_LOG_LOGIC (
" SDUs in TxBuffer = " << m_txBuffer.size ());
275 if (m_txBuffer.size () > 0)
277 NS_LOG_LOGIC (
" First SDU buffer = " << *(m_txBuffer.begin()));
278 NS_LOG_LOGIC (
" First SDU size = " << (*(m_txBuffer.begin()))->GetSize ());
280 NS_LOG_LOGIC (
" Next segment size = " << nextSegmentSize);
289 NS_LOG_LOGIC (
" IF firstSegment < NextSegmentSize && txBuffer.size > 0");
291 dataFieldAddedSize = firstSegment->
GetSize ();
292 dataFieldTotalSize += dataFieldAddedSize;
293 dataField.push_back (firstSegment);
296 rlcHeader.PushExtensionBit (LteRlcHeader::E_LI_FIELDS_FOLLOWS);
299 rlcHeader.PushLengthIndicator (firstSegment->
GetSize ());
301 nextSegmentSize -= ((nextSegmentId % 2) ? (2) : (1)) + dataFieldAddedSize;
304 NS_LOG_LOGIC (
" SDUs in TxBuffer = " << m_txBuffer.size ());
305 if (m_txBuffer.size () > 0)
307 NS_LOG_LOGIC (
" First SDU buffer = " << *(m_txBuffer.begin()));
308 NS_LOG_LOGIC (
" First SDU size = " << (*(m_txBuffer.begin()))->GetSize ());
310 NS_LOG_LOGIC (
" Next segment size = " << nextSegmentSize);
314 firstSegment = (*(m_txBuffer.begin ()))->
Copy ();
315 m_txBufferSize -= (*(m_txBuffer.begin()))->GetSize ();
316 m_txBuffer.erase (m_txBuffer.begin ());
326 std::vector< Ptr<Packet> >::iterator it;
327 it = dataField.begin ();
329 uint8_t framingInfo = 0;
333 (*it)->RemovePacketTag (tag);
334 if ( (tag.GetStatus () == LteRlcSduStatusTag::FULL_SDU) ||
335 (tag.GetStatus () == LteRlcSduStatusTag::FIRST_SEGMENT) )
337 framingInfo |= LteRlcHeader::FIRST_BYTE;
341 framingInfo |= LteRlcHeader::NO_FIRST_BYTE;
343 (*it)->AddPacketTag (tag);
345 while (it < dataField.end ())
347 NS_LOG_LOGIC (
"Adding SDU/segment to packet, length = " << (*it)->GetSize ());
355 (*it)->RemovePacketTag (tag);
356 if ( (tag.GetStatus () == LteRlcSduStatusTag::FULL_SDU) ||
357 (tag.GetStatus () == LteRlcSduStatusTag::LAST_SEGMENT) )
359 framingInfo |= LteRlcHeader::LAST_BYTE;
363 framingInfo |= LteRlcHeader::NO_LAST_BYTE;
365 (*it)->AddPacketTag (tag);
367 rlcHeader.SetFramingInfo (framingInfo);
380 params.rnti = m_rnti;
381 params.lcid = m_lcid;
382 params.layer = layer;
383 params.harqProcessId = harqId;
387 if (! m_txBuffer.empty ())
395 LteRlcUm::DoNotifyHarqDeliveryFailure ()
401 LteRlcUm::DoReceivePdu (Ptr<Packet> p)
403 NS_LOG_FUNCTION (
this << m_rnti << (uint32_t) m_lcid << p->GetSize ());
408 if (p->FindFirstMatchingByteTag (rlcTag))
412 m_rxPdu (m_rnti, m_lcid, p->GetSize (), delay.GetNanoSeconds ());
417 LteRlcHeader rlcHeader;
418 p->PeekHeader (rlcHeader);
420 SequenceNumber10 seqNumber = rlcHeader.GetSequenceNumber ();
450 if ( ( (m_vrUr < seqNumber) && (seqNumber < m_vrUh) && (m_rxBuffer.count (seqNumber.GetValue ()) > 0) ) ||
451 ( ((m_vrUh -
m_windowSize) <= seqNumber) && (seqNumber < m_vrUr) )
461 m_rxBuffer[seqNumber.GetValue ()] = p;
476 if ( ! IsInsideReorderingWindow (seqNumber))
480 m_vrUh = seqNumber + 1;
483 ReassembleOutsideWindow ();
485 if ( ! IsInsideReorderingWindow (m_vrUr) )
488 NS_LOG_LOGIC (
"VR(UR) is outside the reordering window");
499 if ( m_rxBuffer.count (m_vrUr.
GetValue ()) > 0 )
501 NS_LOG_LOGIC (
"Reception buffer contains SN = " << m_vrUr);
503 std::map <uint16_t, Ptr<Packet> >::iterator it;
505 SequenceNumber10 oldVrUr = m_vrUr;
507 it = m_rxBuffer.find (m_vrUr.
GetValue ());
508 newVrUr = (it->first) + 1;
509 while ( m_rxBuffer.count (newVrUr) > 0 )
516 ReassembleSnInterval (oldVrUr, m_vrUr);
533 if ( (m_vrUx <= m_vrUr) ||
534 ((! IsInsideReorderingWindow (m_vrUx)) && (m_vrUx != m_vrUh)) )
549 if ( m_vrUh > m_vrUr )
554 &LteRlcUm::ExpireReorderingTimer ,
this);
564 LteRlcUm::IsInsideReorderingWindow (SequenceNumber10 seqNumber)
568 m_vrUh <<
" - " <<
m_windowSize <<
" <= " << seqNumber <<
" < " << m_vrUh);
573 if ( ((m_vrUh -
m_windowSize) <= seqNumber) && (seqNumber < m_vrUh))
575 NS_LOG_LOGIC (seqNumber <<
" is INSIDE the reordering window");
580 NS_LOG_LOGIC (seqNumber <<
" is OUTSIDE the reordering window");
591 uint8_t framingInfo = rlcHeader.GetFramingInfo ();
597 expectedSnLost =
true;
603 expectedSnLost =
false;
609 uint8_t extensionBit;
610 uint16_t lengthIndicator;
613 extensionBit = rlcHeader.PopExtensionBit ();
616 if ( extensionBit == 0 )
618 m_sdusBuffer.push_back (packet);
622 lengthIndicator = rlcHeader.PopLengthIndicator ();
626 if ( lengthIndicator >= packet->
GetSize () )
628 NS_LOG_LOGIC (
"INTERNAL ERROR: Not enough data in the packet (" << packet->
GetSize () <<
"). Needed LI=" << lengthIndicator);
635 m_sdusBuffer.push_back (data_field);
638 while ( extensionBit == 1 );
640 std::list < Ptr<Packet> >::iterator it;
643 if (m_reassemblingState == WAITING_S0_FULL)
NS_LOG_LOGIC (
"Reassembling State = 'WAITING_S0_FULL'");
644 else if (m_reassemblingState == WAITING_SI_SF)
NS_LOG_LOGIC (
"Reassembling State = 'WAITING_SI_SF'");
645 else NS_LOG_LOGIC (
"Reassembling State = Unknown state");
648 NS_LOG_LOGIC (
"Framing Info = " << (uint16_t)framingInfo);
653 switch (m_reassemblingState)
655 case WAITING_S0_FULL:
658 case (LteRlcHeader::FIRST_BYTE | LteRlcHeader::LAST_BYTE):
659 m_reassemblingState = WAITING_S0_FULL;
664 for ( it = m_sdusBuffer.begin () ; it != m_sdusBuffer.end () ; it++ )
668 m_sdusBuffer.clear ();
671 case (LteRlcHeader::FIRST_BYTE | LteRlcHeader::NO_LAST_BYTE):
672 m_reassemblingState = WAITING_SI_SF;
677 while ( m_sdusBuffer.size () > 1 )
680 m_sdusBuffer.pop_front ();
686 m_keepS0 = m_sdusBuffer.front ();
687 m_sdusBuffer.pop_front ();
690 case (LteRlcHeader::NO_FIRST_BYTE | LteRlcHeader::LAST_BYTE):
691 m_reassemblingState = WAITING_S0_FULL;
696 m_sdusBuffer.pop_front ();
701 while ( ! m_sdusBuffer.empty () )
704 m_sdusBuffer.pop_front ();
708 case (LteRlcHeader::NO_FIRST_BYTE | LteRlcHeader::NO_LAST_BYTE):
709 if ( m_sdusBuffer.size () == 1 )
711 m_reassemblingState = WAITING_S0_FULL;
715 m_reassemblingState = WAITING_SI_SF;
721 m_sdusBuffer.pop_front ();
723 if ( m_sdusBuffer.size () > 0 )
728 while ( m_sdusBuffer.size () > 1 )
731 m_sdusBuffer.pop_front ();
737 m_keepS0 = m_sdusBuffer.front ();
738 m_sdusBuffer.pop_front ();
746 NS_LOG_LOGIC (
"INTERNAL ERROR: Transition not possible. FI = " << (uint32_t) framingInfo);
754 case (LteRlcHeader::NO_FIRST_BYTE | LteRlcHeader::LAST_BYTE):
755 m_reassemblingState = WAITING_S0_FULL;
760 m_keepS0->
AddAtEnd (m_sdusBuffer.front ());
761 m_sdusBuffer.pop_front ();
767 while ( ! m_sdusBuffer.empty () )
770 m_sdusBuffer.pop_front ();
774 case (LteRlcHeader::NO_FIRST_BYTE | LteRlcHeader::NO_LAST_BYTE):
775 m_reassemblingState = WAITING_SI_SF;
780 if ( m_sdusBuffer.size () == 1 )
782 m_keepS0->
AddAtEnd (m_sdusBuffer.front ());
783 m_sdusBuffer.pop_front ();
790 m_keepS0->
AddAtEnd (m_sdusBuffer.front ());
791 m_sdusBuffer.pop_front ();
797 while ( m_sdusBuffer.size () > 1 )
800 m_sdusBuffer.pop_front ();
806 m_keepS0 = m_sdusBuffer.front ();
807 m_sdusBuffer.pop_front ();
811 case (LteRlcHeader::FIRST_BYTE | LteRlcHeader::LAST_BYTE):
812 case (LteRlcHeader::FIRST_BYTE | LteRlcHeader::NO_LAST_BYTE):
817 NS_LOG_LOGIC (
"INTERNAL ERROR: Transition not possible. FI = " << (uint32_t) framingInfo);
823 NS_LOG_LOGIC (
"INTERNAL ERROR: Wrong reassembling state = " << (uint32_t) m_reassemblingState);
829 switch (m_reassemblingState)
831 case WAITING_S0_FULL:
834 case (LteRlcHeader::FIRST_BYTE | LteRlcHeader::LAST_BYTE):
835 m_reassemblingState = WAITING_S0_FULL;
840 for ( it = m_sdusBuffer.begin () ; it != m_sdusBuffer.end () ; it++ )
844 m_sdusBuffer.clear ();
847 case (LteRlcHeader::FIRST_BYTE | LteRlcHeader::NO_LAST_BYTE):
848 m_reassemblingState = WAITING_SI_SF;
853 while ( m_sdusBuffer.size () > 1 )
856 m_sdusBuffer.pop_front ();
862 m_keepS0 = m_sdusBuffer.front ();
863 m_sdusBuffer.pop_front ();
866 case (LteRlcHeader::NO_FIRST_BYTE | LteRlcHeader::LAST_BYTE):
867 m_reassemblingState = WAITING_S0_FULL;
872 m_sdusBuffer.pop_front ();
877 while ( ! m_sdusBuffer.empty () )
880 m_sdusBuffer.pop_front ();
884 case (LteRlcHeader::NO_FIRST_BYTE | LteRlcHeader::NO_LAST_BYTE):
885 if ( m_sdusBuffer.size () == 1 )
887 m_reassemblingState = WAITING_S0_FULL;
891 m_reassemblingState = WAITING_SI_SF;
897 m_sdusBuffer.pop_front ();
899 if ( m_sdusBuffer.size () > 0 )
904 while ( m_sdusBuffer.size () > 1 )
907 m_sdusBuffer.pop_front ();
913 m_keepS0 = m_sdusBuffer.front ();
914 m_sdusBuffer.pop_front ();
922 NS_LOG_LOGIC (
"INTERNAL ERROR: Transition not possible. FI = " << (uint32_t) framingInfo);
930 case (LteRlcHeader::FIRST_BYTE | LteRlcHeader::LAST_BYTE):
931 m_reassemblingState = WAITING_S0_FULL;
941 while ( ! m_sdusBuffer.empty () )
944 m_sdusBuffer.pop_front ();
948 case (LteRlcHeader::FIRST_BYTE | LteRlcHeader::NO_LAST_BYTE):
949 m_reassemblingState = WAITING_SI_SF;
959 while ( m_sdusBuffer.size () > 1 )
962 m_sdusBuffer.pop_front ();
968 m_keepS0 = m_sdusBuffer.front ();
969 m_sdusBuffer.pop_front ();
973 case (LteRlcHeader::NO_FIRST_BYTE | LteRlcHeader::LAST_BYTE):
974 m_reassemblingState = WAITING_S0_FULL;
984 m_sdusBuffer.pop_front ();
989 while ( ! m_sdusBuffer.empty () )
992 m_sdusBuffer.pop_front ();
996 case (LteRlcHeader::NO_FIRST_BYTE | LteRlcHeader::NO_LAST_BYTE):
997 if ( m_sdusBuffer.size () == 1 )
999 m_reassemblingState = WAITING_S0_FULL;
1003 m_reassemblingState = WAITING_SI_SF;
1014 m_sdusBuffer.pop_front ();
1016 if ( m_sdusBuffer.size () > 0 )
1021 while ( m_sdusBuffer.size () > 1 )
1024 m_sdusBuffer.pop_front ();
1030 m_keepS0 = m_sdusBuffer.front ();
1031 m_sdusBuffer.pop_front ();
1039 NS_LOG_LOGIC (
"INTERNAL ERROR: Transition not possible. FI = " << (uint32_t) framingInfo);
1045 NS_LOG_LOGIC (
"INTERNAL ERROR: Wrong reassembling state = " << (uint32_t) m_reassemblingState);
1054 LteRlcUm::ReassembleOutsideWindow (
void)
1058 std::map <uint16_t, Ptr<Packet> >::iterator it;
1059 it = m_rxBuffer.begin ();
1061 while ( (it != m_rxBuffer.end ()) && ! IsInsideReorderingWindow (
SequenceNumber10 (it->first)) )
1068 std::map <uint16_t, Ptr<Packet> >::iterator it_tmp = it;
1070 m_rxBuffer.erase (it_tmp);
1073 if (it != m_rxBuffer.end ())
1075 NS_LOG_LOGIC (
"(SN = " << it->first <<
") is inside the reordering window");
1080 LteRlcUm::ReassembleSnInterval (SequenceNumber10 lowSeqNumber, SequenceNumber10 highSeqNumber)
1082 NS_LOG_LOGIC (
"Reassemble SN between " << lowSeqNumber <<
" and " << highSeqNumber);
1084 std::map <uint16_t, Ptr<Packet> >::iterator it;
1086 SequenceNumber10 reassembleSn = lowSeqNumber;
1089 while (reassembleSn < highSeqNumber)
1092 it = m_rxBuffer.find (reassembleSn.GetValue ());
1095 if (it != m_rxBuffer.end () )
1102 m_rxBuffer.erase (it);
1111 LteRlcUm::DoReportBufferStatus (
void)
1114 uint32_t queueSize = 0;
1116 if (! m_txBuffer.empty ())
1119 m_txBuffer.front ()->PeekPacketTag (holTimeTag);
1122 queueSize = m_txBufferSize + 2 * m_txBuffer.size ();
1125 LteMacSapProvider::ReportBufferStatusParameters r;
1128 r.txQueueSize = queueSize;
1129 r.txQueueHolDelay = holDelay.GetMilliSeconds () ;
1130 r.retxQueueSize = 0;
1131 r.retxQueueHolDelay = 0;
1132 r.statusPduSize = 0;
1134 NS_LOG_LOGIC (
"Send ReportBufferStatus = " << r.txQueueSize <<
", " << r.txQueueHolDelay );
1140 LteRlcUm::ExpireReorderingTimer (
void)
1154 std::map <uint16_t, Ptr<Packet> >::iterator it;
1155 SequenceNumber10 newVrUr = m_vrUx;
1157 while ( (it = m_rxBuffer.find (newVrUr.GetValue ())) != m_rxBuffer.end () )
1161 SequenceNumber10 oldVrUr = m_vrUr;
1165 ReassembleSnInterval (oldVrUr, m_vrUr);
1167 if ( m_vrUh > m_vrUr)
1171 &LteRlcUm::ExpireReorderingTimer,
this);
1179 LteRlcUm::ExpireRbsTimer (
void)
1183 if (! m_txBuffer.empty ())
1185 DoReportBufferStatus ();
uint32_t RemoveHeader(Header &header)
TracedCallback< uint16_t, uint8_t, uint32_t > m_txPdu
#define NS_LOG_FUNCTION(parameters)
uint16_t GetValue() const
Extracts the numeric value of the sequence number.
void ReassembleAndDeliver(Ptr< Packet > packet)
void AddPacketTag(const Tag &tag) const
#define NS_LOG_COMPONENT_DEFINE(name)
uint32_t GetSize(void) const
virtual void DoTransmitPdcpPdu(Ptr< Packet > p)
bool IsRunning(void) const
static EventId Schedule(Time const &time, MEM mem_ptr, OBJ obj)
SequenceNumber10 m_sequenceNumber
Ptr< Packet > CreateFragment(uint32_t start, uint32_t length) const
void AddAtEnd(Ptr< const Packet > packet)
SequenceNumber10 m_expectedSeqNumber
void RemoveAtStart(uint32_t size)
virtual void DoNotifyTxOpportunity(uint32_t bytes, uint8_t layer, uint8_t harqId)
virtual void ReceivePdcpPdu(Ptr< Packet > p)=0
#define NS_LOG_LOGIC(msg)
Ptr< Packet > Copy(void) const
EventId m_reorderingTimer
This class implements a tag that carries the status of a RLC SDU for the fragmentation process Status...
bool RemovePacketTag(Tag &tag)
virtual void ReportBufferStatus(ReportBufferStatusParameters params)=0
Time MilliSeconds(uint64_t ms)
create ns3::Time instances in units of milliseconds.
TracedCallback< uint16_t, uint8_t, uint32_t, uint64_t > m_rxPdu
virtual void TransmitPdu(TransmitPduParameters params)=0
void AddHeader(const Header &header)
void AddByteTag(const Tag &tag) const