satellite-beam-scheduler.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) 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 SAT_BEAM_SCHEDULER_H
#define SAT_BEAM_SCHEDULER_H
 
#include "satellite-cno-estimator.h"
#include "satellite-enums.h"
#include "satellite-frame-allocator.h"
#include "satellite-gw-mac.h"
#include "satellite-net-device.h"
#include "satellite-orbiter-net-device.h"
 
#include "ns3/callback.h"
#include "ns3/nstime.h"
#include "ns3/object.h"
#include "ns3/ptr.h"
#include "ns3/simple-ref-count.h"
#include "ns3/traced-callback.h"
 
#include <cmath>
#include <list>
#include <map>
#include <stdint.h>
#include <string>
#include <utility>
#include <vector>
 
namespace ns3
{
 
class Address;
class Ipv4Address;
class SatControlMessage;
class SatCrMessage;
class SatTbtpMessage;
class SatTimuMessage;
class SatSuperframeSeq;
class SatSuperframeAllocator;
class SatLowerLayerServiceConf;
class SatDamaEntry;

class SatBeamScheduler : public Object
{
  public:
    typedef enum
    {
        BASIC,
        CHECK_GATEWAY
    } HandoverInformationForward_t;

    static TypeId GetTypeId(void);

    SatBeamScheduler();

    ~SatBeamScheduler();

    typedef Callback<bool, Ptr<SatControlMessage>, const Address&> SendCtrlMsgCallback;

    typedef Callback<void, Ptr<SatTbtpMessage>> SendTbtpCallback;

    typedef Callback<void, uint32_t, Ptr<SatTbtpMessage>> TbtpAddCallback;

    void Initialize(uint32_t satId,
                    uint32_t beamId,
                    Ptr<SatNetDevice> gwNetDevice,
                    Ptr<SatOrbiterNetDevice> orbiterNetDevice,
                    SatBeamScheduler::SendCtrlMsgCallback cb,
                    Ptr<SatSuperframeSeq> seq,
                    uint32_t maxFrameSizeInBytes,
                    Address satAddress,
                    Address gwAddress);

    uint32_t AddUt(Address utId, Ptr<SatLowerLayerServiceConf> llsConf);

    bool HasUt(Address utId);

    bool HasUt();

    void UpdateUtCno(Address utId, double cno);

    void UpdateSatelliteCno(Address satelliteMac, double cno);

    void UtCrReceived(Address utId, Ptr<SatCrMessage> crMsg);

    bool Send(Ptr<SatControlMessage> message);

    bool SendTo(Ptr<SatControlMessage> message, Address utId);

    bool SendToSatellite(Ptr<SatControlMessage> msg, Address satelliteMac);

    void SetSendTbtpCallback(SendTbtpCallback cb);

    typedef void (*BacklogRequestsTraceCallback)(std::string trace);

    typedef void (*WaveformTraceCallback)(uint32_t waveformId);

    typedef void (*UsableCapacityTraceCallback)(uint32_t usableCapacity);

    typedef void (*UnmetCapacityTraceCallback)(uint32_t unmetCapacity);

    typedef void (*ExceedingCapacityTraceCallback)(uint32_t exceedingCapacity);

    Ptr<SatTimuMessage> CreateTimu() const;

    void TransferUtToBeam(Address utId, Ptr<SatBeamScheduler> destination);

    void ConnectUt(Mac48Address address);

    void DisconnectUt(Mac48Address address);

    void ConnectGw(Mac48Address address);

    void DisconnectGw(Mac48Address address);

    void RemoveUt(Address utId);
 
    void ReserveLogonChannel(uint32_t logonChannelId);

    inline Address GetSatAddress(void) const
    {
        return m_satAddress;
    }

    inline Address GetGwAddress(void) const
    {
        return m_gwAddress;
    }

    void SetUseLora(bool useLora);
 
  private:
    class SatUtInfo : public SimpleRefCount<SatUtInfo>
    {
      public:
        SatUtInfo(Ptr<SatDamaEntry> damaEntry,
                  Ptr<SatCnoEstimator> cnoEstimator,
                  Time controlSlotOffset,
                  bool controlSlotsEnabled);

        Ptr<SatDamaEntry> GetDamaEntry();

        void UpdateDamaEntryFromCrs();

        void AddCnoSample(double sample);

        double GetCnoEstimation();

        void AddCrMsg(Ptr<SatCrMessage> crMsg);

        void ClearCrMsgs();

        bool IsControlSlotGenerationTime() const;

        void SetControlSlotGenerationTime(Time offset);
 
      private:
        typedef std::vector<Ptr<SatCrMessage>> CrMsgContainer_t;

        Ptr<SatDamaEntry> m_damaEntry;

        Ptr<SatCnoEstimator> m_cnoEstimator;

        CrMsgContainer_t m_crContainer;

        Time m_controlSlotGenerationTime;

        bool m_controlSlotsEnabled;
    };

    typedef std::pair<Address, SatFrameAllocator::SatFrameAllocReq> UtReqInfoItem_t;

    typedef std::map<Address, Ptr<SatUtInfo>> UtInfoMap_t;

    typedef std::list<UtReqInfoItem_t> UtReqInfoContainer_t;

    class CnoCompare
    {
      public:
        CnoCompare(const UtInfoMap_t& utInfoMap)
            : m_utInfoMap(utInfoMap)
        {
        }

        bool operator()(UtReqInfoItem_t utReqInfo1, UtReqInfoItem_t utReqInfo2)
        {
            double result = false;
 
            double cnoFirst = m_utInfoMap.at(utReqInfo1.first)->GetCnoEstimation();
            double cnoSecond = m_utInfoMap.at(utReqInfo2.first)->GetCnoEstimation();
 
            if (!std::isnan(cnoFirst))
            {
                if (std::isnan(cnoSecond))
                {
                    result = false;
                }
                else
                {
                    result = (cnoFirst < cnoSecond);
                }
            }
 
            return result;
        }
 
      private:
        const UtInfoMap_t& m_utInfoMap;
    };

    uint32_t m_satId;

    uint32_t m_beamId;

    Ptr<SatGwMac> m_gwMac;

    Ptr<SatOrbiterNetDevice> m_orbiterNetDevice;

    Ptr<SatSuperframeSeq> m_superframeSeq;

    uint32_t m_superFrameCounter;

    SatBeamScheduler::SendCtrlMsgCallback m_txCallback;

    SatBeamScheduler::SendTbtpCallback m_txTbtpCallback;

    UtInfoMap_t m_utInfos;

    UtReqInfoContainer_t m_utRequestInfos;

    Ptr<RandomVariableStream> m_raChRandomIndex;

    uint32_t m_logonChannelIndex;

    SatCnoEstimator::EstimationMode_t m_cnoEstimatorMode;

    Time m_cnoEstimationWindow;

    Ptr<SatSuperframeAllocator> m_superframeAllocator;

    Time m_maxTwoWayPropagationDelay;

    Time m_maxTbtpTxAndProcessingDelay;

    uint32_t m_maxBbFrameSize;

    Time m_controlSlotInterval;

    bool m_controlSlotsEnabled;

    TracedCallback<std::string> m_backlogRequestsTrace;

    TracedCallback<uint32_t> m_waveformTrace;

    TracedCallback<uint32_t, uint32_t> m_frameUtLoadTrace;

    TracedCallback<uint32_t, double> m_frameLoadTrace;

    TracedCallback<uint32_t> m_usableCapacityTrace;

    TracedCallback<uint32_t> m_unmetCapacityTrace;

    TracedCallback<uint32_t> m_exceedingCapacityTrace;

    void DoDispose(void);

    void Schedule();

    uint32_t UpdateDamaEntriesWithReqs();

    uint32_t UpdateDamaEntriesWithAllocs(
        SatFrameAllocator::UtAllocInfoContainer_t& utAllocContainer);

    void DoPreResourceAllocation();

    void AddRaChannels(std::vector<Ptr<SatTbtpMessage>>& tbtpContainer);
 
    void AddUtInfo(Address utId, Ptr<SatUtInfo> utInfo);
    void RemoveUtInfo(UtInfoMap_t::iterator iterator);

    Ptr<SatCnoEstimator> CreateCnoEstimator();

    void SendCnoToSatellite();
 
    Address m_satAddress;
 
    Address m_gwAddress;
 
    HandoverInformationForward_t m_handoverStrategy;

    SatEnums::SuperframeAllocatorType_t m_superframeAllocatorType;

    Ptr<SatCnoEstimator> m_satelliteCnoEstimator;

    Address m_satelliteMac;

    bool m_receivedSatelliteCnoSample;

    bool m_useLora;
};
 
} // namespace ns3
 
#endif /* SAT_BEAM_SCHEDULER_H */