satellite-default-superframe-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
 * Copyright (c) 2019 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: Joaquin Muguerza <jmuguerza@viveris.fr>
 */
 
#ifndef SAT_DEFAULT_SUPERFRAME_ALLOCATOR_H
#define SAT_DEFAULT_SUPERFRAME_ALLOCATOR_H
 
#include "satellite-control-message.h"
#include "satellite-enums.h"
#include "satellite-frame-allocator.h"
#include "satellite-frame-conf.h"
#include "satellite-superframe-allocator.h"
 
#include "ns3/address.h"
#include "ns3/simple-ref-count.h"
#include "ns3/traced-callback.h"
 
#include <map>
#include <stdint.h>
#include <vector>
 
namespace ns3
{

class SatDefaultSuperframeAllocator : public SatSuperframeAllocator
{
  public:
    SatDefaultSuperframeAllocator(Ptr<SatSuperframeConf> superFrameConf);

    ~SatDefaultSuperframeAllocator();

    static TypeId GetTypeId(void);

    void ReserveMinimumRate(uint32_t minimumRateBytes, bool controlSlotsEnabled);

    void ReleaseMinimumRate(uint32_t minimumRateBytes, bool controlSlotsEnabled);

    void PreAllocateSymbols(SatFrameAllocator::SatFrameAllocContainer_t& allocReqs);

    void GenerateTimeSlots(SatFrameAllocator::TbtpMsgContainer_t& tbtpContainer,
                           uint32_t maxSizeInBytes,
                           SatFrameAllocator::UtAllocInfoContainer_t& utAllocContainer,
                           TracedCallback<uint32_t> waveformTrace,
                           TracedCallback<uint32_t, uint32_t> utLoadTrace,
                           TracedCallback<uint32_t, double> loadTrace);
 
  private:
    typedef std::vector<Ptr<SatFrameAllocator>> FrameAllocatorContainer_t;

    typedef std::map<Ptr<SatFrameAllocator>, uint32_t> SupportedFramesMap_t;
 
    // Frame info container.
    FrameAllocatorContainer_t m_frameAllocators;
 
    // target load for the frame
    double m_targetLoad;
 
    // flag telling if FCA (free capacity allocation) is on
    bool m_fcaEnabled;
 
    // minimum carrier payload in bytes
    uint32_t m_minCarrierPayloadInBytes;
 
    // minimum rate based bytes left can been guaranteed by frame allocator
    uint32_t m_minimumRateBasedBytesLeft;
 
    // The flag telling if time slot generation is done per RC based symbols
    // instead of UT based symbols
    bool m_rcBasedAllocationEnabled;
 
    // the most robust
    uint32_t m_mostRobustSlotPayloadInBytes;
 
    // the total bandwidth for all configured frames
    double m_totalBandwidth;

    bool AllocateBasedOnCc(SatFrameAllocator::CcLevel_t ccLevel,
                           SatFrameAllocator::SatFrameAllocReq* allocReq,
                           const SupportedFramesMap_t& frames);

    bool AllocateToFrame(SatFrameAllocator::SatFrameAllocReq* allocReq);

    void RemoveAllocations();

    void SelectCarriers(SatFrameAllocator::SatFrameAllocContainer_t& allocReqs);

    Ptr<SatFrameAllocator> SelectBestCarrier(double cno, uint32_t& bestWaveFormId);
};
 
} // namespace ns3
 
#endif /* SAT_DEFAULT_SUPERFRAME_ALLOCATOR_H */