satellite-control-message.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013 Magister Solutions Ltd
 * Copyright (c) 2018 CNES
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Sami Rantanen <sami.rantanen@magister.fi>
 * Author: Mathias Ettinger <mettinger@toulouse.viveris.com>
 */
 
#ifndef SATELLITE_CONTROL_MESSAGE_H
#define SATELLITE_CONTROL_MESSAGE_H
 
#include "satellite-enums.h"
#include "satellite-frame-conf.h"
#include "satellite-mac-tag.h"
 
#include "ns3/header.h"
#include "ns3/mac48-address.h"
#include "ns3/nstime.h"
#include "ns3/object.h"
#include "ns3/simulator.h"
 
#include <map>
#include <ostream>
#include <set>
#include <stdint.h>
#include <utility>
#include <vector>
 
namespace ns3
{

class SatControlMsgTag : public Tag
{
  public:
    typedef enum
    {
        SAT_NON_CTRL_MSG,            
        SAT_TBTP_CTRL_MSG,           
        SAT_CR_CTRL_MSG,             
        SAT_RA_CTRL_MSG,             
        SAT_ARQ_ACK,                 
        SAT_CN0_REPORT,              
        SAT_TIMU_CTRL_MSG,           
        SAT_HR_CTRL_MSG,             
        SAT_SLICE_CTRL_MSG,          
        SAT_LOGON_CTRL_MSG,          
        SAT_LOGON_RESPONSE_CTRL_MSG, 
        SAT_LOGOFF_CTRL_MSG,         
        SAT_NCR_CTRL_MSG,            
        SAT_CMT_CTRL_MSG             
    } SatControlMsgType_t;

    SatControlMsgTag();

    ~SatControlMsgTag();

    void SetMsgType(SatControlMsgType_t type);

    SatControlMsgType_t GetMsgType(void) const;

    virtual void SetMsgId(uint32_t msgId);

    virtual uint32_t GetMsgId() const;

    static TypeId GetTypeId(void);

    virtual TypeId GetInstanceTypeId(void) const;

    virtual uint32_t GetSerializedSize(void) const;

    virtual void Serialize(TagBuffer i) const;

    virtual void Deserialize(TagBuffer i);

    virtual void Print(std::ostream& os) const;
 
  private:
    SatControlMsgType_t m_msgType;
    uint32_t m_msgId;
};

 
class SatControlMessage : public Object
{
  public:
    static TypeId GetTypeId(void);

    SatControlMessage()
    {
    }

    ~SatControlMessage()
    {
    }

    virtual uint32_t GetSizeInBytes() const = 0;

    virtual SatControlMsgTag::SatControlMsgType_t GetMsgType() const = 0;
 
  private:
};

 
class SatTbtpMessage : public SatControlMessage
{
  public:
    typedef std::vector<Ptr<SatTimeSlotConf>> DaTimeSlotConfContainer_t;

    typedef std::pair<uint8_t, DaTimeSlotConfContainer_t> DaTimeSlotInfoItem_t;

    typedef std::set<uint8_t> RaChannelInfoContainer_t;

    static const uint32_t m_tbtpBodySizeInBytes = 6;

    static const uint32_t m_tbtpFrameBodySizeInBytes = 5;

    static TypeId GetTypeId(void);

    SatTbtpMessage();

    SatTbtpMessage(uint8_t seqId);

    ~SatTbtpMessage();

    inline SatControlMsgTag::SatControlMsgType_t GetMsgType() const
    {
        return SatControlMsgTag::SAT_TBTP_CTRL_MSG;
    }

    inline void SetSuperframeCounter(uint32_t counter)
    {
        m_superframeCounter = counter;
    }

    inline uint8_t GetSuperframeSeqId()
    {
        return m_superframeSeqId;
    }

    inline uint32_t GetSuperframeCounter()
    {
        return m_superframeCounter;
    }

    inline uint32_t GetFrameInfoSize() const
    {
        return m_tbtpFrameBodySizeInBytes;
    }

    const DaTimeSlotInfoItem_t& GetDaTimeslots(Address utId);

    void SetDaTimeslot(Mac48Address utId, uint8_t frameId, Ptr<SatTimeSlotConf> conf);

    const RaChannelInfoContainer_t GetRaChannels() const;

    void SetRaChannel(uint32_t raChannel, uint8_t frameId, uint16_t timeSlotCount);

    virtual uint32_t GetSizeInBytes() const;

    uint32_t GetTimeSlotInfoSizeInBytes() const;

    void Dump() const;
 
  private:
    typedef std::map<uint8_t, uint16_t> RaChannelMap_t;
    typedef std::map<Address, DaTimeSlotInfoItem_t> DaTimeSlotMap_t;
 
    DaTimeSlotMap_t m_daTimeSlots;
    RaChannelMap_t m_raChannels;
    uint32_t m_superframeCounter;
    uint8_t m_superframeSeqId;
    uint8_t m_assignmentFormat;
    std::set<uint8_t> m_frameIds;

    const DaTimeSlotInfoItem_t m_emptyDaSlotContainer;
};

class SatCrMessage : public SatControlMessage
{
  public:
    typedef enum
    {
        CR_BLOCK_SMALL,
        CR_BLOCK_LARGE
    } SatCrBlockSize_t;

    SatCrMessage();

    ~SatCrMessage();

    static TypeId GetTypeId(void);

    typedef std::pair<uint8_t, SatEnums::SatCapacityAllocationCategory_t> RequestDescriptor_t;

    typedef std::map<RequestDescriptor_t, uint16_t> RequestContainer_t;

    inline SatControlMsgTag::SatControlMsgType_t GetMsgType() const
    {
        return SatControlMsgTag::SAT_CR_CTRL_MSG;
    }

    void AddControlElement(uint8_t rcIndex,
                           SatEnums::SatCapacityAllocationCategory_t cac,
                           uint32_t value);

    const RequestContainer_t GetCapacityRequestContent() const;

    uint32_t GetNumCapacityRequestElements() const;

    double GetCnoEstimate() const;

    void SetCnoEstimate(double cno);

    virtual uint32_t GetSizeInBytes() const;

    bool IsNotEmpty() const;
 
  private:
    RequestContainer_t m_requestData;

    SatCrBlockSize_t m_crBlockSizeType;

    double m_forwardLinkCNo;

    static const uint32_t CONTROL_MSG_TYPE_VALUE_SIZE_IN_BYTES = 1;

    static const uint32_t CONTROL_MSG_COMMON_HEADER_SIZE_IN_BYTES = 3;
};

 
class SatArqAckMessage : public SatControlMessage
{
  public:
    SatArqAckMessage();

    ~SatArqAckMessage();

    static TypeId GetTypeId(void);

    inline SatControlMsgTag::SatControlMsgType_t GetMsgType() const
    {
        return SatControlMsgTag::SAT_ARQ_ACK;
    }

    void SetSequenceNumber(uint8_t sn);

    uint8_t GetSequenceNumber() const;

    void SetFlowId(uint8_t sn);

    uint8_t GetFlowId() const;

    virtual uint32_t GetSizeInBytes() const;
 
  private:
    uint8_t m_sequenceNumber;
    uint8_t m_flowId;
};

 
class SatCnoReportMessage : public SatControlMessage
{
  public:
    SatCnoReportMessage();

    ~SatCnoReportMessage();

    static TypeId GetTypeId(void);

    inline SatControlMsgTag::SatControlMsgType_t GetMsgType() const
    {
        return SatControlMsgTag::SAT_CN0_REPORT;
    }

    double GetCnoEstimate() const;

    void SetCnoEstimate(double cno);

    virtual uint32_t GetSizeInBytes() const;
 
  private:
    double m_linkCNo;
};

 
class SatRaMessage : public SatControlMessage
{
  public:
    SatRaMessage();

    ~SatRaMessage();

    static TypeId GetTypeId(void);

    inline SatControlMsgTag::SatControlMsgType_t GetMsgType() const
    {
        return SatControlMsgTag::SAT_RA_CTRL_MSG;
    }

    uint16_t GetBackoffProbability() const;

    void SetBackoffProbability(uint16_t backoffProbability);

    uint16_t GetBackoffTime() const;

    void SetBackoffTime(uint16_t backoffTime);

    uint8_t GetAllocationChannelId() const;

    void SetAllocationChannelId(uint8_t allocationChannel);

    virtual uint32_t GetSizeInBytes() const;
 
  private:
    static const uint32_t RA_CONTROL_MSG_HEADER_SIZE_IN_BYTES = 5;

    uint8_t m_allocationChannelId;

    uint16_t m_backoffProbability;

    uint16_t m_backoffTime;
};

 
class SatTimuMessage : public SatControlMessage
{
  public:
    SatTimuMessage();

    ~SatTimuMessage();

    static TypeId GetTypeId(void);

    inline SatControlMsgTag::SatControlMsgType_t GetMsgType() const
    {
        return SatControlMsgTag::SAT_TIMU_CTRL_MSG;
    }

    uint32_t GetAllocatedBeamId() const;

    void SetAllocatedBeamId(uint32_t beamId);

    uint32_t GetAllocatedSatId() const;

    void SetAllocatedSatId(uint32_t beamId);
 
    Address GetSatAddress() const;
 
    void SetSatAddress(Address address);
 
    Address GetGwAddress() const;
 
    void SetGwAddress(Address address);

    virtual uint32_t GetSizeInBytes() const;
 
  private:
    uint32_t m_beamId;

    uint32_t m_satId;

    Address m_satAddress;

    Address m_gwAddress;
};

 
class SatHandoverRecommendationMessage : public SatControlMessage
{
  public:
    SatHandoverRecommendationMessage();

    ~SatHandoverRecommendationMessage();

    static TypeId GetTypeId(void);

    inline SatControlMsgTag::SatControlMsgType_t GetMsgType() const
    {
        return SatControlMsgTag::SAT_HR_CTRL_MSG;
    }

    uint32_t GetRecommendedBeamId() const;

    void SetRecommendedBeamId(uint32_t beamId);

    uint32_t GetRecommendedSatId() const;

    void SetRecommendedSatId(uint32_t beamId);

    virtual uint32_t GetSizeInBytes() const;
 
  private:
    uint32_t m_beamId;

    uint32_t m_satId;
};

class SatSliceSubscriptionMessage : public SatControlMessage
{
  public:
    SatSliceSubscriptionMessage();

    ~SatSliceSubscriptionMessage();

    static TypeId GetTypeId(void);

    inline SatControlMsgTag::SatControlMsgType_t GetMsgType() const
    {
        return SatControlMsgTag::SAT_SLICE_CTRL_MSG;
    }

    uint32_t GetSliceId() const;

    void SetSliceId(uint8_t sliceId);

    Mac48Address GetAddress() const;

    void SetAddress(Mac48Address address);

    virtual uint32_t GetSizeInBytes() const;
 
  private:
    uint8_t m_sliceId;

    Mac48Address m_address;
};

class SatLogonMessage : public SatControlMessage
{
  public:
    SatLogonMessage();

    ~SatLogonMessage();

    static TypeId GetTypeId(void);

    inline SatControlMsgTag::SatControlMsgType_t GetMsgType() const
    {
        return SatControlMsgTag::SAT_LOGON_CTRL_MSG;
    }

    virtual uint32_t GetSizeInBytes() const;
 
  private:
};

class SatLogonResponseMessage : public SatControlMessage
{
  public:
    SatLogonResponseMessage();

    ~SatLogonResponseMessage();

    static TypeId GetTypeId(void);

    inline SatControlMsgTag::SatControlMsgType_t GetMsgType() const
    {
        return SatControlMsgTag::SAT_LOGON_RESPONSE_CTRL_MSG;
    }

    uint32_t GetRaChannel() const;

    void SetRaChannel(uint32_t raChannel);

    virtual uint32_t GetSizeInBytes() const;
 
  private:
    Time m_delay;
    uint32_t m_raChannel;
};

class SatLogoffMessage : public SatControlMessage
{
  public:
    SatLogoffMessage();

    ~SatLogoffMessage();

    static TypeId GetTypeId(void);

    inline SatControlMsgTag::SatControlMsgType_t GetMsgType() const
    {
        return SatControlMsgTag::SAT_LOGOFF_CTRL_MSG;
    }

    virtual uint32_t GetSizeInBytes() const;
 
  private:
};

class SatNcrMessage : public SatControlMessage
{
  public:
    SatNcrMessage();

    ~SatNcrMessage();

    static TypeId GetTypeId(void);

    inline SatControlMsgTag::SatControlMsgType_t GetMsgType() const
    {
        return SatControlMsgTag::SAT_NCR_CTRL_MSG;
    }

    uint64_t GetNcrDate() const;

    void SetNcrDate(uint64_t ncr);

    virtual uint32_t GetSizeInBytes() const;
 
  private:
    uint64_t m_ncrDateBase;
    uint16_t m_ncrDateExtension;
};

class SatCmtMessage : public SatControlMessage
{
  public:
    SatCmtMessage();

    ~SatCmtMessage();

    static TypeId GetTypeId(void);

    inline SatControlMsgTag::SatControlMsgType_t GetMsgType() const
    {
        return SatControlMsgTag::SAT_CMT_CTRL_MSG;
    }

    uint8_t GetGroupId() const;

    void SetGroupId(uint8_t groupId);

    uint8_t GetLogonId() const;

    void SetLogonId(uint8_t logonId);

    int16_t GetBurstTimeCorrection() const;

    void SetBurstTimeCorrection(int32_t burstTimeCorrection);

    uint8_t GetPowerCorrection() const;

    void SetPowerCorrection(uint8_t powerCorrection);

    int16_t GetFrequencyCorrection() const;

    void SetFrequencyCorrection(int16_t frequencyCorrection);

    virtual uint32_t GetSizeInBytes() const;
 
  private:
    uint8_t m_groupId;
    uint8_t m_logonId;
    uint8_t m_burstTimeScaling;
    int8_t m_burstTimeCorrection;
    uint8_t m_powerCorrection;
    int16_t m_frequencyCorrection;
};

class SatControlMsgContainer : public SimpleRefCount<SatControlMsgContainer>
{
  public:
    SatControlMsgContainer();

    SatControlMsgContainer(Time m_storeTime, bool deleteOnRead);

    ~SatControlMsgContainer();

    uint32_t ReserveIdAndStore(Ptr<SatControlMessage> controlMsg);

    uint32_t Send(uint32_t sendId);

    Ptr<SatControlMessage> Read(uint32_t recvId);
 
  private:
    void EraseFirst();

    void CleanUpIdMap(uint32_t recvId);
 
    typedef std::map<uint32_t, Ptr<SatControlMessage>> ReservedCtrlMsgMap_t;
    typedef std::map<uint32_t, uint32_t> CtrlIdMap_t;
    typedef std::pair<Time, Ptr<SatControlMessage>> CtrlMsgMapValue_t;
    typedef std::map<uint32_t, CtrlMsgMapValue_t> CtrlMsgMap_t;
 
    ReservedCtrlMsgMap_t m_reservedCtrlMsgs;
    CtrlMsgMap_t m_ctrlMsgs;
    CtrlIdMap_t m_ctrlIdMap;
    uint32_t m_sendId;
    uint32_t m_recvId;
    EventId m_storeTimeout;

    Time m_storeTime;

    bool m_deleteOnRead;
};
 
} // namespace ns3
 
#endif // SATELLITE_CONTROL_MESSAGE_H