satellite-request-manager.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: Jani Puttonen <jani.puttonen@magister.fi>
 * Author: Mathias Ettinger <mettinger@toulouse.viveris.com>
 */
 
#ifndef SATELLITE_REQUEST_MANAGER_H_
#define SATELLITE_REQUEST_MANAGER_H_
 
#include "satellite-control-message.h"
#include "satellite-enums.h"
#include "satellite-lower-layer-service.h"
#include "satellite-node-info.h"
#include "satellite-queue.h"
 
#include "ns3/callback.h"
#include "ns3/object.h"
 
#include <deque>
#include <map>
#include <stdint.h>
#include <string>
#include <utility>
#include <vector>
 
namespace ns3
{

class SatRequestManager : public Object
{
  public:
    SatRequestManager();

    virtual ~SatRequestManager();
 
    void Initialize(Ptr<SatLowerLayerServiceConf> llsConf, Time superFrameDuration);

    static TypeId GetTypeId(void);

    virtual void DoDispose();

    typedef Callback<SatQueue::QueueStats_t, bool> QueueCallback;

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

    typedef Callback<bool> CtrlMsgTxPossibleCallback;

    typedef Callback<bool> LogonMsgTxPossibleCallback;

    typedef std::vector<std::deque<std::pair<Time, uint32_t>>> PendingRbdcRequestsContainer_t;

    void ReceiveQueueEvent(SatQueue::QueueEvent_t event, uint8_t rcIndex);

    void AddQueueCallback(uint8_t rcIndex, SatRequestManager::QueueCallback cb);

    void SetCtrlMsgCallback(SatRequestManager::SendCtrlCallback cb);

    void SetCtrlMsgTxPossibleCallback(SatRequestManager::CtrlMsgTxPossibleCallback cb);

    void SetLogonMsgTxPossibleCallback(SatRequestManager::LogonMsgTxPossibleCallback cb);

    void SetGwAddress(Mac48Address address);

    void SetNodeInfo(Ptr<SatNodeInfo> nodeInfo);

    void CnoUpdated(uint32_t satId,
                    uint32_t beamId,
                    Address sourceMac,
                    Address gwId,
                    double cno,
                    bool isSatelliteMac);

    void AssignedDaResources(uint8_t rcIndex, uint32_t bytes);

    typedef void (*CapacityRequestTraceCallback)(Time time,
                                                 Mac48Address address,
                                                 Ptr<SatCrMessage> message);

    typedef void (*CapacityRequestTraceLogCallback)(std::string traceLog);

    typedef void (*RbdcTraceCallback)(uint32_t requestSize);

    typedef void (*VbdcTraceCallback)(uint32_t requestSize);

    typedef void (*AvbdcTraceCallback)(uint32_t requestSize);

    void SendHandoverRecommendation(uint32_t satId, uint32_t beamId);

    void SendLogonMessage();

    void SetHeaderOffsetVbdc(double headerOffsetVbcd);
 
  private:
    typedef std::map<uint8_t, QueueCallback> CallbackContainer_t;

    void DoPeriodicalEvaluation();

    void DoEvaluation();

    uint32_t DoRbdc(uint8_t rc, const SatQueue::QueueStats_t& stats);

    uint32_t DoRbdcLegacy(uint8_t rc, const SatQueue::QueueStats_t& stats);

    SatEnums::SatCapacityAllocationCategory_t DoVbdc(uint8_t rc,
                                                     const SatQueue::QueueStats_t& stats,
                                                     uint32_t& rcVbdcBytes);

    SatEnums::SatCapacityAllocationCategory_t DoVbdcLegacy(uint8_t rc,
                                                           const SatQueue::QueueStats_t& stats,
                                                           uint32_t& rcVbdcBytes);

    uint32_t GetVbdcBytes(uint8_t rc, const SatQueue::QueueStats_t& stats);

    uint32_t GetAvbdcBytes(uint8_t rc, const SatQueue::QueueStats_t& stats);

    void CheckForVolumeBacklogPersistence();

    uint32_t GetPendingRbdcSumKbps(uint8_t rc);

    void UpdatePendingRbdcCounters(uint8_t rc, uint32_t kbps);

    void RemoveOldEntriesFromPendingRbdcContainer(uint8_t rc);

    void UpdatePendingVbdcCounters();

    void UpdatePendingVbdcCounters(uint8_t rc);

    void SendCapacityRequest(Ptr<SatCrMessage> crMsg);

    void SendCnoReport();

    void ResetAssignedResources();

    void Reset(uint8_t rc);

    uint16_t GetQuantizedRbdcValue(uint8_t index, uint16_t reqRbdcKbps) const;

    uint16_t GetQuantizedVbdcValue(uint8_t index, uint16_t reqVbdcBytes) const;

    CallbackContainer_t m_queueCallbacks;

    SendCtrlCallback m_ctrlCallback;

    CtrlMsgTxPossibleCallback m_ctrlMsgTxPossibleCallback;

    LogonMsgTxPossibleCallback m_logonMsgTxPossibleCallback;

    Mac48Address m_gwAddress;

    Mac48Address m_satAddress;

    double m_lastCno;

    double m_lastSatelliteCno;

    Ptr<SatLowerLayerServiceConf> m_llsConf;

    Time m_evaluationInterval;

    Time m_cnoReportInterval;

    EventId m_cnoReportEvent;

    double m_gainValueK;

    Time m_rttEstimate;

    double m_overEstimationFactor;

    bool m_enableOnDemandEvaluation;

    PendingRbdcRequestsContainer_t m_pendingRbdcRequestsKbps;

    std::vector<uint32_t> m_pendingVbdcBytes;

    std::vector<Time> m_previousEvaluationTime;

    Ptr<SatNodeInfo> m_nodeInfo;

    std::vector<uint32_t> m_assignedDaResourcesBytes;

    Time m_lastVbdcCrSent;

    Time m_superFrameDuration;

    bool m_forcedAvbdcUpdate;
 
    uint32_t m_numValues;
    static const uint32_t m_rbdcScalingFactors[4];
    static const uint32_t m_vbdcScalingFactors[4];

    TracedCallback<Time, Mac48Address, Ptr<SatCrMessage>> m_crTrace;

    TracedCallback<std::string> m_crTraceLog;

    TracedCallback<uint32_t> m_rbdcTrace;
    TracedCallback<uint32_t> m_vbdcTrace;
    TracedCallback<uint32_t> m_aVbdcTrace;

    SatEnums::RbdcCapacityRequestAlgorithm_t m_rbdcCapacityRequestAlgorithm;

    SatEnums::VbdcCapacityRequestAlgorithm_t m_vbdcCapacityRequestAlgorithm;

    double m_headerOffsetVbcd;
};
 
} // namespace ns3
 
#endif /* SATELLITE_REQUEST_MANAGER_H_ */