nr-rlc-am.h

// Copyright (c) 2011 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
//
// SPDX-License-Identifier: GPL-2.0-only
//
// Author: Manuel Requena <manuel.requena@cttc.es>
 
#ifndef NR_RLC_AM_H
#define NR_RLC_AM_H
 
#include "nr-rlc-sequence-number.h"
#include "nr-rlc.h"
 
#include "ns3/event-id.h"
 
#include <map>
#include <vector>
 
namespace ns3
{
 
class NrRlcAm : public NrRlc
{
  public:
    NrRlcAm();
    ~NrRlcAm() override;
    static TypeId GetTypeId();
    void DoDispose() override;
 
    void DoTransmitPdcpPdu(Ptr<Packet> p) override;
 
    void DoNotifyTxOpportunity(NrMacSapUser::TxOpportunityParameters txOpParams) override;
    void DoNotifyHarqDeliveryFailure() override;
    void DoReceivePdu(NrMacSapUser::ReceivePduParameters rxPduParams) override;
 
  private:
    void ExpireReorderingTimer();
    void ExpirePollRetransmitTimer();
    void ExpireBsrTimer();
 
    void ExpireStatusProhibitTimer();
 
    bool IsInsideReceivingWindow(nr::SequenceNumber10 seqNumber);
    //
    //   void ReassembleOutsideWindow ();
    //   void ReassembleSnLessThan (uint16_t seqNumber);
    //
 
    void ReassembleAndDeliver(Ptr<Packet> packet);
 
    void DoTransmitBufferStatusReport();
 
  private:
    struct TxPdu
    {
        TxPdu(const Ptr<Packet>& pdu, const Time& time)
            : m_pdu(pdu),
              m_waitingSince(time)
        {
        }
 
        TxPdu() = delete;
 
        Ptr<Packet> m_pdu;   
        Time m_waitingSince; 
    };
 
    std::vector<TxPdu> m_txonBuffer; 
 
    struct RetxPdu
    {
        Ptr<Packet> m_pdu;    
        uint16_t m_retxCount; 
        Time m_waitingSince;  
    };
 
    std::vector<RetxPdu> m_txedBuffer; 
    std::vector<RetxPdu> m_retxBuffer; 
 
    uint32_t m_maxTxBufferSize; 
    uint32_t m_txonBufferSize;  
    uint32_t m_retxBufferSize;  
    uint32_t m_txedBufferSize;  
 
    bool m_statusPduRequested;      
    uint32_t m_statusPduBufferSize; 
 
    struct PduBuffer
    {
        nr::SequenceNumber10 m_seqNumber;      
        std::list<Ptr<Packet>> m_byteSegments; 
 
        bool m_pduComplete; 
    };
 
    std::map<uint16_t, PduBuffer> m_rxonBuffer; 
 
    Ptr<Packet> m_controlPduBuffer; 
 
    // SDU reassembly
    //   std::vector < Ptr<Packet> > m_reasBuffer;     // Reassembling buffer
    //
    std::list<Ptr<Packet>> m_sdusBuffer; 
 
    // Transmitting side
    nr::SequenceNumber10 m_vtA;    
    nr::SequenceNumber10 m_vtMs;   
    nr::SequenceNumber10 m_vtS;    
    nr::SequenceNumber10 m_pollSn; 
 
    // Receiving side
    nr::SequenceNumber10 m_vrR;  
    nr::SequenceNumber10 m_vrMr; 
    nr::SequenceNumber10 m_vrX;  
    nr::SequenceNumber10 m_vrMs; 
    nr::SequenceNumber10 m_vrH;  
 
    uint32_t m_pduWithoutPoll;  
    uint32_t m_byteWithoutPoll; 
 
    uint16_t m_windowSize;
 
    EventId m_pollRetransmitTimer;   
    Time m_pollRetransmitTimerValue; 
    EventId m_reorderingTimer;       
    Time m_reorderingTimerValue;     
    EventId m_statusProhibitTimer;   
    Time m_statusProhibitTimerValue; 
    EventId m_bsrTimer;              
    Time m_bsrTimerValue;            
 
    uint16_t m_maxRetxThreshold; 
    uint16_t m_pollPdu;          
    uint16_t m_pollByte;         
 
    bool m_txOpportunityForRetxAlwaysBigEnough; 
    bool m_pollRetransmitTimerJustExpired;      
 
    enum ReassemblingState_t
    {
        NONE = 0,
        WAITING_S0_FULL = 1,
        WAITING_SI_SF = 2
    };
 
    ReassemblingState_t m_reassemblingState; 
    Ptr<Packet> m_keepS0;                    
 
    nr::SequenceNumber10 m_expectedSeqNumber;
};
 
} // namespace ns3
 
#endif // NR_RLC_AM_H