nr-rrc-header.h

// Copyright (c) 2012 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
//
// SPDX-License-Identifier: GPL-2.0-only
//
// Author: Lluis Parcerisa <lparcerisa@cttc.cat>
// Modified by:
//          Danilo Abrignani <danilo.abrignani@unibo.it> (Carrier Aggregation - GSoC 2015)
//          Biljana Bojovic <biljana.bojovic@cttc.es> (Carrier Aggregation)
 
#ifndef NR_RRC_HEADER_H
#define NR_RRC_HEADER_H
 
#include "nr-asn1-header.h"
#include "nr-rrc-sap.h"
 
#include "ns3/header.h"
 
#include <bitset>
#include <string>
 
namespace ns3
{
 
class NrRrcAsn1Header : public NrAsn1Header
{
  public:
    NrRrcAsn1Header();
    int GetMessageType() const;
 
  protected:
    static TypeId GetTypeId();
    // Inherited from NrAsn1Header
    TypeId GetInstanceTypeId() const override;
    uint32_t Deserialize(Buffer::Iterator bIterator) override = 0;
    void PreSerialize() const override = 0;
 
    // Auxiliary functions
    int BandwidthToEnum(uint16_t bandwidth) const;
    uint16_t EnumToBandwidth(int n) const;
 
    // Serialization functions
    void SerializeSrbToAddModList(std::list<NrRrcSap::SrbToAddMod> srbToAddModList) const;
    void SerializeDrbToAddModList(std::list<NrRrcSap::DrbToAddMod> drbToAddModList) const;
    void SerializeLogicalChannelConfig(NrRrcSap::LogicalChannelConfig logicalChannelConfig) const;
    void SerializeRadioResourceConfigDedicated(
        NrRrcSap::RadioResourceConfigDedicated radioResourceConfigDedicated) const;
    void SerializePhysicalConfigDedicated(
        NrRrcSap::PhysicalConfigDedicated physicalConfigDedicated) const;
    void SerializePhysicalConfigDedicatedSCell(NrRrcSap::PhysicalConfigDedicatedSCell pcdsc) const;
    void SerializeSystemInformationBlockType1(
        NrRrcSap::SystemInformationBlockType1 systemInformationBlockType1) const;
    void SerializeSystemInformationBlockType2(
        NrRrcSap::SystemInformationBlockType2 systemInformationBlockType2) const;
    void SerializeRadioResourceConfigCommon(
        NrRrcSap::RadioResourceConfigCommon radioResourceConfigCommon) const;
    void SerializeRadioResourceConfigCommonSib(
        NrRrcSap::RadioResourceConfigCommonSib radioResourceConfigCommonSib) const;
    void SerializeMeasResults(NrRrcSap::MeasResults measResults) const;
    void SerializePlmnIdentity(uint32_t plmnId) const;
    void SerializeRachConfigCommon(NrRrcSap::RachConfigCommon rachConfigCommon) const;
    void SerializeMeasConfig(NrRrcSap::MeasConfig measConfig) const;
    void SerializeNonCriticalExtensionConfiguration(
        NrRrcSap::NonCriticalExtensionConfiguration nonCriticalExtensionConfiguration) const;
    void SerializeRadioResourceConfigCommonSCell(
        NrRrcSap::RadioResourceConfigCommonSCell rrccsc) const;
    void SerializeRadioResourceDedicatedSCell(
        NrRrcSap::RadioResourceConfigDedicatedSCell rrcdsc) const;
    void SerializeQoffsetRange(int8_t qOffsetRange) const;
    void SerializeThresholdEutra(NrRrcSap::ThresholdEutra thresholdEutra) const;
 
    // Deserialization functions
    Buffer::Iterator DeserializeDrbToAddModList(std::list<NrRrcSap::DrbToAddMod>* drbToAddModLis,
                                                Buffer::Iterator bIterator);
    Buffer::Iterator DeserializeSrbToAddModList(std::list<NrRrcSap::SrbToAddMod>* srbToAddModList,
                                                Buffer::Iterator bIterator);
    Buffer::Iterator DeserializeLogicalChannelConfig(
        NrRrcSap::LogicalChannelConfig* logicalChannelConfig,
        Buffer::Iterator bIterator);
    Buffer::Iterator DeserializeRadioResourceConfigDedicated(
        NrRrcSap::RadioResourceConfigDedicated* radioResourceConfigDedicated,
        Buffer::Iterator bIterator);
    Buffer::Iterator DeserializePhysicalConfigDedicated(
        NrRrcSap::PhysicalConfigDedicated* physicalConfigDedicated,
        Buffer::Iterator bIterator);
    Buffer::Iterator DeserializeSystemInformationBlockType1(
        NrRrcSap::SystemInformationBlockType1* systemInformationBlockType1,
        Buffer::Iterator bIterator);
    Buffer::Iterator DeserializeSystemInformationBlockType2(
        NrRrcSap::SystemInformationBlockType2* systemInformationBlockType2,
        Buffer::Iterator bIterator);
    Buffer::Iterator DeserializeRadioResourceConfigCommon(
        NrRrcSap::RadioResourceConfigCommon* radioResourceConfigCommon,
        Buffer::Iterator bIterator);
    Buffer::Iterator DeserializeRadioResourceConfigCommonSib(
        NrRrcSap::RadioResourceConfigCommonSib* radioResourceConfigCommonSib,
        Buffer::Iterator bIterator);
    Buffer::Iterator DeserializeMeasResults(NrRrcSap::MeasResults* measResults,
                                            Buffer::Iterator bIterator);
    Buffer::Iterator DeserializePlmnIdentity(uint32_t* plmnId, Buffer::Iterator bIterator);
    Buffer::Iterator DeserializeRachConfigCommon(NrRrcSap::RachConfigCommon* rachConfigCommon,
                                                 Buffer::Iterator bIterator);
    Buffer::Iterator DeserializeMeasConfig(NrRrcSap::MeasConfig* measConfig,
                                           Buffer::Iterator bIterator);
    Buffer::Iterator DeserializeQoffsetRange(int8_t* qOffsetRange, Buffer::Iterator bIterator);
    Buffer::Iterator DeserializeThresholdEutra(NrRrcSap::ThresholdEutra* thresholdEutra,
                                               Buffer::Iterator bIterator);
    Buffer::Iterator DeserializeNonCriticalExtensionConfig(
        NrRrcSap::NonCriticalExtensionConfiguration* nonCriticalExtension,
        Buffer::Iterator bIterator);
    Buffer::Iterator DeserializeCellIdentification(NrRrcSap::CellIdentification* ci,
                                                   Buffer::Iterator bIterator);
    Buffer::Iterator DeserializeRadioResourceConfigCommonSCell(
        NrRrcSap::RadioResourceConfigCommonSCell* rrccsc,
        Buffer::Iterator bIterator);
    Buffer::Iterator DeserializeRadioResourceConfigDedicatedSCell(
        NrRrcSap::RadioResourceConfigDedicatedSCell* rrcdsc,
        Buffer::Iterator bIterator);
    Buffer::Iterator DeserializePhysicalConfigDedicatedSCell(
        NrRrcSap::PhysicalConfigDedicatedSCell* pcdsc,
        Buffer::Iterator bIterator);
 
    void Print(std::ostream& os) const override;
    void Print(std::ostream& os,
               NrRrcSap::RadioResourceConfigDedicated radioResourceConfigDedicated) const;
 
    int m_messageType;
};
 
class NrRrcUlDcchMessage : public NrRrcAsn1Header
{
  public:
    NrRrcUlDcchMessage();
    ~NrRrcUlDcchMessage() override;
 
    // Inherited from NrRrcAsn1Header
    uint32_t Deserialize(Buffer::Iterator bIterator) override;
    void Print(std::ostream& os) const override;
    void PreSerialize() const override;
 
  protected:
    void SerializeUlDcchMessage(int msgType) const;
    Buffer::Iterator DeserializeUlDcchMessage(Buffer::Iterator bIterator);
};
 
class NrRrcDlDcchMessage : public NrRrcAsn1Header
{
  public:
    NrRrcDlDcchMessage();
    ~NrRrcDlDcchMessage() override;
 
    // Inherited from NrRrcAsn1Header
    uint32_t Deserialize(Buffer::Iterator bIterator) override;
    void Print(std::ostream& os) const override;
    void PreSerialize() const override;
 
  protected:
    void SerializeDlDcchMessage(int msgType) const;
    Buffer::Iterator DeserializeDlDcchMessage(Buffer::Iterator bIterator);
};
 
class NrRrcUlCcchMessage : public NrRrcAsn1Header
{
  public:
    NrRrcUlCcchMessage();
    ~NrRrcUlCcchMessage() override;
 
    // Inherited from NrRrcAsn1Header
    uint32_t Deserialize(Buffer::Iterator bIterator) override;
    void Print(std::ostream& os) const override;
    void PreSerialize() const override;
 
  protected:
    void SerializeUlCcchMessage(int msgType) const;
    Buffer::Iterator DeserializeUlCcchMessage(Buffer::Iterator bIterator);
};
 
class NrRrcDlCcchMessage : public NrRrcAsn1Header
{
  public:
    NrRrcDlCcchMessage();
    ~NrRrcDlCcchMessage() override;
 
    // Inherited from NrRrcAsn1Header
    uint32_t Deserialize(Buffer::Iterator bIterator) override;
    void Print(std::ostream& os) const override;
    void PreSerialize() const override;
 
  protected:
    void SerializeDlCcchMessage(int msgType) const;
    Buffer::Iterator DeserializeDlCcchMessage(Buffer::Iterator bIterator);
};
 
class NrRrcConnectionRequestHeader : public NrRrcUlCcchMessage
{
  public:
    NrRrcConnectionRequestHeader();
    ~NrRrcConnectionRequestHeader() override;
 
    static TypeId GetTypeId();
    // Inherited from NrRrcAsn1Header
    void PreSerialize() const override;
    uint32_t Deserialize(Buffer::Iterator bIterator) override;
    void Print(std::ostream& os) const override;
 
    void SetMessage(NrRrcSap::RrcConnectionRequest msg);
 
    NrRrcSap::RrcConnectionRequest GetMessage() const;
 
    std::bitset<8> GetMmec() const;
 
    std::bitset<32> GetMtmsi() const;
 
  private:
    std::bitset<8> m_mmec;   
    std::bitset<32> m_mTmsi; 
 
    enum
    {
        EMERGENCY = 0,
        HIGHPRIORITYACCESS,
        MT_ACCESS,
        MO_SIGNALLING,
        MO_DATA,
        SPARE3,
        SPARE2,
        SPARE1
    } m_establishmentCause; 
 
    std::bitset<1> m_spare; 
};
 
class NrRrcConnectionSetupHeader : public NrRrcDlCcchMessage
{
  public:
    NrRrcConnectionSetupHeader();
    ~NrRrcConnectionSetupHeader() override;
 
    // Inherited from NrRrcAsn1Header
    void PreSerialize() const override;
    uint32_t Deserialize(Buffer::Iterator bIterator) override;
    void Print(std::ostream& os) const override;
 
    void SetMessage(NrRrcSap::RrcConnectionSetup msg);
 
    NrRrcSap::RrcConnectionSetup GetMessage() const;
 
    uint8_t GetRrcTransactionIdentifier() const;
 
    NrRrcSap::RadioResourceConfigDedicated GetRadioResourceConfigDedicated() const;
 
    bool HavePhysicalConfigDedicated() const;
 
    NrRrcSap::PhysicalConfigDedicated GetPhysicalConfigDedicated() const;
 
    std::list<NrRrcSap::SrbToAddMod> GetSrbToAddModList() const;
 
    std::list<NrRrcSap::DrbToAddMod> GetDrbToAddModList() const;
 
    std::list<uint8_t> GetDrbToReleaseList() const;
 
  private:
    uint8_t m_rrcTransactionIdentifier; 
    mutable NrRrcSap::RadioResourceConfigDedicated
        m_radioResourceConfigDedicated; 
};
 
class NrRrcConnectionSetupCompleteHeader : public NrRrcUlDcchMessage
{
  public:
    NrRrcConnectionSetupCompleteHeader();
    ~NrRrcConnectionSetupCompleteHeader() override;
 
    // Inherited from NrRrcAsn1Header
    void PreSerialize() const override;
    uint32_t Deserialize(Buffer::Iterator bIterator) override;
    void Print(std::ostream& os) const override;
 
    void SetMessage(NrRrcSap::RrcConnectionSetupCompleted msg);
 
    NrRrcSap::RrcConnectionSetupCompleted GetMessage() const;
 
    uint8_t GetRrcTransactionIdentifier() const;
 
  private:
    uint8_t m_rrcTransactionIdentifier; 
};
 
class NrRrcConnectionReconfigurationCompleteHeader : public NrRrcUlDcchMessage
{
  public:
    NrRrcConnectionReconfigurationCompleteHeader();
    ~NrRrcConnectionReconfigurationCompleteHeader() override;
 
    // Inherited from NrRrcAsn1Header
    void PreSerialize() const override;
    uint32_t Deserialize(Buffer::Iterator bIterator) override;
    void Print(std::ostream& os) const override;
 
    void SetMessage(NrRrcSap::RrcConnectionReconfigurationCompleted msg);
 
    NrRrcSap::RrcConnectionReconfigurationCompleted GetMessage() const;
 
    uint8_t GetRrcTransactionIdentifier() const;
 
  private:
    uint8_t m_rrcTransactionIdentifier; 
};
 
class NrRrcConnectionReconfigurationHeader : public NrRrcDlDcchMessage
{
  public:
    NrRrcConnectionReconfigurationHeader();
    ~NrRrcConnectionReconfigurationHeader() override;
 
    // Inherited from NrRrcAsn1Header
    void PreSerialize() const override;
    uint32_t Deserialize(Buffer::Iterator bIterator) override;
    void Print(std::ostream& os) const override;
 
    void SetMessage(NrRrcSap::RrcConnectionReconfiguration msg);
 
    NrRrcSap::RrcConnectionReconfiguration GetMessage() const;
 
    bool GetHaveMeasConfig() const;
 
    NrRrcSap::MeasConfig GetMeasConfig();
 
    bool GetHaveMobilityControlInfo() const;
 
    NrRrcSap::MobilityControlInfo GetMobilityControlInfo();
 
    bool GetHaveRadioResourceConfigDedicated() const;
 
    NrRrcSap::RadioResourceConfigDedicated GetRadioResourceConfigDedicated();
 
    uint8_t GetRrcTransactionIdentifier() const;
 
    NrRrcSap::RadioResourceConfigDedicated GetRadioResourceConfigDedicated() const;
 
    bool GetHaveNonCriticalExtensionConfig() const;
 
    NrRrcSap::NonCriticalExtensionConfiguration GetNonCriticalExtensionConfig();
 
    bool HavePhysicalConfigDedicated() const;
 
    NrRrcSap::PhysicalConfigDedicated GetPhysicalConfigDedicated() const;
 
    std::list<NrRrcSap::SrbToAddMod> GetSrbToAddModList() const;
 
    std::list<NrRrcSap::DrbToAddMod> GetDrbToAddModList() const;
 
    std::list<uint8_t> GetDrbToReleaseList() const;
 
  private:
    uint8_t m_rrcTransactionIdentifier;                  
    bool m_haveMeasConfig;                               
    NrRrcSap::MeasConfig m_measConfig;                   
    bool m_haveMobilityControlInfo;                      
    NrRrcSap::MobilityControlInfo m_mobilityControlInfo; 
    bool m_haveRadioResourceConfigDedicated;             
    NrRrcSap::RadioResourceConfigDedicated
        m_radioResourceConfigDedicated; 
    bool m_haveNonCriticalExtension;    
    NrRrcSap::NonCriticalExtensionConfiguration
        m_nonCriticalExtension; 
};
 
class NrHandoverPreparationInfoHeader : public NrRrcAsn1Header
{
  public:
    NrHandoverPreparationInfoHeader();
 
    // Inherited from NrRrcAsn1Header
    void PreSerialize() const override;
    uint32_t Deserialize(Buffer::Iterator bIterator) override;
    void Print(std::ostream& os) const override;
 
    void SetMessage(NrRrcSap::HandoverPreparationInfo msg);
 
    NrRrcSap::HandoverPreparationInfo GetMessage() const;
 
    NrRrcSap::AsConfig GetAsConfig() const;
 
  private:
    NrRrcSap::AsConfig m_asConfig; 
};
 
class NrRrcConnectionReestablishmentRequestHeader : public NrRrcUlCcchMessage
{
  public:
    NrRrcConnectionReestablishmentRequestHeader();
    ~NrRrcConnectionReestablishmentRequestHeader() override;
 
    // Inherited from NrRrcAsn1Header
    void PreSerialize() const override;
    uint32_t Deserialize(Buffer::Iterator bIterator) override;
    void Print(std::ostream& os) const override;
 
    void SetMessage(NrRrcSap::RrcConnectionReestablishmentRequest msg);
 
    NrRrcSap::RrcConnectionReestablishmentRequest GetMessage() const;
 
    NrRrcSap::ReestabUeIdentity GetUeIdentity() const;
 
    NrRrcSap::ReestablishmentCause GetReestablishmentCause() const;
 
  private:
    NrRrcSap::ReestabUeIdentity m_ueIdentity;              
    NrRrcSap::ReestablishmentCause m_reestablishmentCause; 
};
 
class NrRrcConnectionReestablishmentHeader : public NrRrcDlCcchMessage
{
  public:
    NrRrcConnectionReestablishmentHeader();
    ~NrRrcConnectionReestablishmentHeader() override;
 
    // Inherited from NrRrcAsn1Header
    void PreSerialize() const override;
    uint32_t Deserialize(Buffer::Iterator bIterator) override;
    void Print(std::ostream& os) const override;
 
    void SetMessage(NrRrcSap::RrcConnectionReestablishment msg);
 
    NrRrcSap::RrcConnectionReestablishment GetMessage() const;
 
    uint8_t GetRrcTransactionIdentifier() const;
 
    NrRrcSap::RadioResourceConfigDedicated GetRadioResourceConfigDedicated() const;
 
  private:
    uint8_t m_rrcTransactionIdentifier; 
    NrRrcSap::RadioResourceConfigDedicated
        m_radioResourceConfigDedicated; 
};
 
class NrRrcConnectionReestablishmentCompleteHeader : public NrRrcUlDcchMessage
{
  public:
    NrRrcConnectionReestablishmentCompleteHeader();
 
    // Inherited from NrRrcAsn1Header
    void PreSerialize() const override;
    uint32_t Deserialize(Buffer::Iterator bIterator) override;
    void Print(std::ostream& os) const override;
 
    void SetMessage(NrRrcSap::RrcConnectionReestablishmentComplete msg);
 
    NrRrcSap::RrcConnectionReestablishmentComplete GetMessage() const;
 
    uint8_t GetRrcTransactionIdentifier() const;
 
  private:
    uint8_t m_rrcTransactionIdentifier; 
};
 
class NrRrcConnectionReestablishmentRejectHeader : public NrRrcDlCcchMessage
{
  public:
    NrRrcConnectionReestablishmentRejectHeader();
    ~NrRrcConnectionReestablishmentRejectHeader() override;
 
    // Inherited from NrRrcAsn1Header
    void PreSerialize() const override;
    uint32_t Deserialize(Buffer::Iterator bIterator) override;
    void Print(std::ostream& os) const override;
 
    void SetMessage(NrRrcSap::RrcConnectionReestablishmentReject msg);
 
    NrRrcSap::RrcConnectionReestablishmentReject GetMessage() const;
 
  private:
    NrRrcSap::RrcConnectionReestablishmentReject
        m_rrcConnectionReestablishmentReject; 
};
 
class NrRrcConnectionReleaseHeader : public NrRrcDlDcchMessage
{
  public:
    NrRrcConnectionReleaseHeader();
    ~NrRrcConnectionReleaseHeader() override;
 
    // Inherited from NrRrcAsn1Header
    void PreSerialize() const override;
    uint32_t Deserialize(Buffer::Iterator bIterator) override;
    void Print(std::ostream& os) const override;
 
    void SetMessage(NrRrcSap::RrcConnectionRelease msg);
 
    NrRrcSap::RrcConnectionRelease GetMessage() const;
 
  private:
    NrRrcSap::RrcConnectionRelease m_rrcConnectionRelease; 
};
 
class NrRrcConnectionRejectHeader : public NrRrcDlCcchMessage
{
  public:
    NrRrcConnectionRejectHeader();
    ~NrRrcConnectionRejectHeader() override;
 
    // Inherited from NrRrcAsn1Header
    void PreSerialize() const override;
    uint32_t Deserialize(Buffer::Iterator bIterator) override;
    void Print(std::ostream& os) const override;
 
    void SetMessage(NrRrcSap::RrcConnectionReject msg);
 
    NrRrcSap::RrcConnectionReject GetMessage() const;
 
  private:
    NrRrcSap::RrcConnectionReject m_rrcConnectionReject; 
};
 
class NrMeasurementReportHeader : public NrRrcUlDcchMessage
{
  public:
    NrMeasurementReportHeader();
    ~NrMeasurementReportHeader() override;
 
    // Inherited from NrRrcAsn1Header
    void PreSerialize() const override;
    uint32_t Deserialize(Buffer::Iterator bIterator) override;
    void Print(std::ostream& os) const override;
 
    void SetMessage(NrRrcSap::MeasurementReport msg);
 
    NrRrcSap::MeasurementReport GetMessage() const;
 
  private:
    NrRrcSap::MeasurementReport m_measurementReport; 
};
 
} // namespace ns3
 
#endif // RRC_HEADER_H