satellite-frame-allocator.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2014 Magister Solutions Ltd
 *
 * 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>
 */
 
#ifndef SAT_FRAME_ALLOCATOR_H
#define SAT_FRAME_ALLOCATOR_H
 
#include "satellite-control-message.h"
#include "satellite-frame-conf.h"
 
#include "ns3/address.h"
#include "ns3/simple-ref-count.h"
#include "ns3/traced-callback.h"
 
#include <list>
#include <map>
#include <stdint.h>
#include <utility>
#include <vector>
 
namespace ns3
{

class SatFrameAllocator : public SimpleRefCount<SatFrameAllocator>
{
  public:
    typedef std::vector<Ptr<SatTbtpMessage>> TbtpMsgContainer_t;

    typedef std::pair<std::vector<uint32_t>, bool> UtAllocInfoItem_t;

    typedef std::map<Address, UtAllocInfoItem_t> UtAllocInfoContainer_t;

    class SatFrameAllocReqItem
    {
      public:
        uint32_t m_craBytes;
        uint32_t m_minRbdcBytes;
        uint32_t m_rbdcBytes;
        uint32_t m_vbdcBytes;
 
        SatFrameAllocReqItem()
            : m_craBytes(0),
              m_minRbdcBytes(0),
              m_rbdcBytes(0),
              m_vbdcBytes(0)
        {
        }
    };

    typedef std::vector<SatFrameAllocReqItem> SatFrameAllocReqItemContainer_t;

    class SatFrameAllocReq
    {
      public:
        bool m_generateCtrlSlot;
        double m_cno;
        Address m_address;
        SatFrameAllocReqItemContainer_t m_reqPerRc;
 
        SatFrameAllocReq()
            : m_generateCtrlSlot(false),
              m_cno(NAN)
        {
        }

        SatFrameAllocReq(SatFrameAllocReqItemContainer_t req)
            : m_generateCtrlSlot(false),
              m_cno(NAN),
              m_reqPerRc(req)
        {
        }
    };

    typedef std::vector<SatFrameAllocReq*> SatFrameAllocContainer_t;

    typedef enum
    {
        CC_LEVEL_CRA,           
        CC_LEVEL_CRA_MIN_RBDC,  
        CC_LEVEL_CRA_RBDC,      
        CC_LEVEL_CRA_RBDC_VBDC, 
    } CcLevel_t;

    struct BandwidthComparator
    {
        bool operator()(const Ptr<SatFrameAllocator>& a, const Ptr<SatFrameAllocator>& b) const;
    };

    SatFrameAllocator();

    SatFrameAllocator(Ptr<SatFrameConf> frameConf,
                      uint8_t frameId,
                      SatSuperframeConf::ConfigType_t m_configType,
                      Ptr<SatFrameAllocator> parent);

    inline uint32_t GetCarrierMinPayloadInBytes() const
    {
        return m_frameConf->GetCarrierMinPayloadInBytes();
    }

    inline Ptr<SatWaveform> GetMostRobustWaveform() const
    {
        return m_mostRobustWaveform;
    }

    inline uint16_t GetCarrierCount() const
    {
        return m_maxCarrierCount;
    }

    void SelectCarriers(uint16_t& amount, uint16_t offset);
 
    inline double GetCarrierBandwidthHz(bool checkParent = false) const
    {
        if (checkParent && m_frameConf->IsSubdivided())
        {
            return 0.0;
        }
        return m_frameConf->GetCarrierBandwidthHz(SatEnums::EFFECTIVE_BANDWIDTH);
    }
 
    inline double GetVolumeBytes() const
    {
        return m_maxSymbolsPerCarrier;
    }
 
    inline Ptr<SatFrameAllocator> GetParent() const
    {
        return m_parent;
    }

    void Reset();

    bool GetBestWaveform(double cno, uint32_t& waveFormId, double& cnoThreshold) const;

    double GetCcLoad(CcLevel_t ccLevel);

    bool Allocate(CcLevel_t ccLevel, SatFrameAllocReq* allocReq, uint32_t waveformId);

    void PreAllocateSymbols(double targetLoad, bool fcaEnabled);

    void GenerateTimeSlots(SatFrameAllocator::TbtpMsgContainer_t& tbtpContainer,
                           uint32_t maxSizeInBytes,
                           UtAllocInfoContainer_t& utAllocContainer,
                           bool rcBasedAllocationEnabled,
                           TracedCallback<uint32_t> waveformTrace,
                           TracedCallback<uint32_t, uint32_t> utLoadTrace,
                           TracedCallback<uint32_t, double> loadTrace);
 
  private:
    class SatFrameAllocInfoItem
    {
      public:
        double m_craSymbols;
        double m_minRbdcSymbols;
        double m_rbdcSymbols;
        double m_vbdcSymbols;

        SatFrameAllocInfoItem()
            : m_craSymbols(0.0),
              m_minRbdcSymbols(0.0),
              m_rbdcSymbols(0.0),
              m_vbdcSymbols(0.0)
        {
        }

        double GetTotalSymbols()
        {
            return (m_craSymbols + m_rbdcSymbols + m_vbdcSymbols);
        }
    };

    typedef std::vector<SatFrameAllocInfoItem> SatFrameAllocInfoItemContainer_t;

    class SatFrameAllocInfo
    {
      public:
        bool m_ctrlSlotPresent;
        double m_craSymbols;
        double m_minRbdcSymbols;
        double m_rbdcSymbols;
        double m_vbdcSymbols;

        SatFrameAllocInfoItemContainer_t m_allocInfoPerRc;

        SatFrameAllocInfo();

        SatFrameAllocInfo(uint8_t countOfRcs);

        SatFrameAllocInfo(SatFrameAllocReqItemContainer_t& req,
                          Ptr<SatWaveform> trcWaveForm,
                          bool ctrlSlotPresent,
                          double ctrlSlotLength);

        SatFrameAllocInfoItem UpdateTotalCounts();

        double GetTotalSymbols();
    };

    typedef struct
    {
        double m_cno;
        SatFrameAllocInfo m_request;
        SatFrameAllocInfo m_allocation;
    } UtAllocItem_t;

    typedef std::pair<Address, uint8_t> RcAllocItem_t;

    typedef std::map<Address, UtAllocItem_t> UtAllocContainer_t;

    typedef std::list<RcAllocItem_t> RcAllocContainer_t;

    class CcReqCompare
    {
      public:
        typedef enum
        {
            CC_TYPE_MIN_RBDC, 
            CC_TYPE_RBDC,     
            CC_TYPE_VBDC,     
        } CcReqType_t;

        CcReqCompare(const UtAllocContainer_t& utAllocContainer,
                     CcReqCompare::CcReqType_t ccReqType);

        bool operator()(RcAllocItem_t rcAlloc1, RcAllocItem_t rcAlloc2);
 
      private:
        const UtAllocContainer_t& m_utAllocContainer;

        CcReqType_t m_ccReqType;
    };
 
    bool m_allocationDenied;
 
    // total symbols in frame.
    double m_totalSymbolsInFrame;
 
    // available (left) symbols in frame.
    double m_availableSymbolsInFrame;
 
    // pre-allocated CRA symbols in frame
    double m_preAllocatedCraSymbols;
 
    // pre-allocated minimum RBDC symbols in frame
    double m_preAllocatedMinRdbcSymbols;
 
    // pre-allocated RBDC symbols in frame
    double m_preAllocatedRdbcSymbols;
 
    // pre-allocated minimum VBDC symbols in frame
    double m_preAllocatedVdbcSymbols;
 
    // maximum symbols available in frame
    double m_maxSymbolsPerCarrier;
 
    // maximum carriers available in frame
    uint16_t m_maxCarrierCount;
 
    // skipped carriers at the beginning of the frame
    uint16_t m_carriersOffset;
 
    // configuration type of the frame
    SatSuperframeConf::ConfigType_t m_configType;
 
    // Id of the frame
    uint8_t m_frameId;
 
    // Burst lengths in use.
    SatWaveformConf::BurstLengthContainer_t m_burstLenghts;
 
    // Waveform configuration
    Ptr<SatWaveformConf> m_waveformConf;
 
    // Frame configuration
    Ptr<SatFrameConf> m_frameConf;
 
    // Parent allocator in case of carrier subdivision
    Ptr<SatFrameAllocator> m_parent;
 
    // UT allocation container
    UtAllocContainer_t m_utAllocs;
 
    // RC allocation container
    RcAllocContainer_t m_rcAllocs;
 
    // The most robust waveform
    Ptr<SatWaveform> m_mostRobustWaveform;
 
    // Guard time in symbols to apply
    uint8_t m_guardTimeSymbols;

    void ShareSymbols(bool fcaEnabled);

    uint32_t GetOptimalBurtsLengthInSymbols(int64_t symbolsToUse,
                                            int64_t symbolsLeft,
                                            double cno,
                                            uint32_t& waveformId);

    Ptr<SatTimeSlotConf> CreateTimeSlot(uint16_t carrierId,
                                        int64_t& utSymbolsToUse,
                                        int64_t& carrierSymbolsToUse,
                                        int64_t& utSymbolsLeft,
                                        int64_t& rcSymbolsLeft,
                                        double cno,
                                        bool rcBasedAllocationEnabled);

    Ptr<SatTimeSlotConf> CreateCtrlTimeSlot(uint16_t carrierId,
                                            int64_t& utSymbolsToUse,
                                            int64_t& carrierSymbolsToUse,
                                            int64_t& utSymbolsLeft,
                                            int64_t& rcSymbolsLeft,
                                            bool rcBasedAllocationEnabled);

    void UpdateAndStoreAllocReq(Address address, double cno, SatFrameAllocInfo& req);

    void AcceptRequests(CcLevel_t ccLevel);

    std::vector<Address> SortUts();

    std::vector<uint16_t> SortCarriers();

    std::vector<uint32_t> SortUtRcs(Address ut);

    SatFrameAllocator::UtAllocInfoContainer_t::iterator GetUtAllocItem(
        UtAllocInfoContainer_t& allocContainer,
        Address ut);

    Ptr<SatTbtpMessage> CreateNewTbtp(TbtpMsgContainer_t& tbtpContainer);
};
 
} // namespace ns3
 
#endif /* SAT_FRAME_ALLOCATOR_H */