satellite-fwd-link-scheduler.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013 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_FWD_LINK_SCHEDULER_H
#define SAT_FWD_LINK_SCHEDULER_H
 
#include "satellite-bbframe-conf.h"
#include "satellite-bbframe-container.h"
#include "satellite-bbframe.h"
#include "satellite-cno-estimator.h"
#include "satellite-mac.h"
#include "satellite-net-device.h"
#include "satellite-phy.h"
#include "satellite-scheduling-object.h"
#include "satellite-signal-parameters.h"
 
#include "ns3/address.h"
#include "ns3/callback.h"
#include "ns3/mac48-address.h"
#include "ns3/node.h"
#include "ns3/nstime.h"
#include "ns3/packet.h"
#include "ns3/ptr.h"
#include "ns3/random-variable-stream.h"
#include "ns3/timer.h"
#include "ns3/traced-callback.h"
 
#include <cstring>
#include <map>
#include <math.h>
#include <stdint.h>
#include <utility>
#include <vector>
 
namespace ns3
{

 
class SatFwdLinkScheduler : public Object
{
  public:
    typedef enum
    {
        NO_SORT,              
        BUFFERING_DELAY_SORT, 
        BUFFERING_LOAD_SORT,  
        RANDOM_SORT,          
        PRIORITY_SORT         
    } ScheduleSortingCriteria_t;

    static bool CompareSoFlowId(Ptr<SatSchedulingObject> obj1, Ptr<SatSchedulingObject> obj2);

    static bool CompareSoPriorityLoad(Ptr<SatSchedulingObject> obj1, Ptr<SatSchedulingObject> obj2);

    static bool CompareSoPriorityHol(Ptr<SatSchedulingObject> obj1, Ptr<SatSchedulingObject> obj2);

    static TypeId GetTypeId(void);

    SatFwdLinkScheduler();

    SatFwdLinkScheduler(Ptr<SatBbFrameConf> conf,
                        Mac48Address address,
                        double carrierBandwidthInHz);

    virtual void NotifyConstructionCompleted() override;

    ~SatFwdLinkScheduler();

    virtual std::pair<Ptr<SatBbFrame>, const Time> GetNextFrame();

    typedef Callback<void, std::vector<Ptr<SatSchedulingObject>>&> SchedContextCallback;

    typedef Callback<Ptr<Packet>, uint32_t, Mac48Address, uint8_t, uint32_t&, uint32_t&>
        TxOpportunityCallback;

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

    void SetSchedContextCallback(SatFwdLinkScheduler::SchedContextCallback cb);

    void SetTxOpportunityCallback(SatFwdLinkScheduler::TxOpportunityCallback cb);

    void SetSendControlMsgCallback(SatFwdLinkScheduler::SendControlMsgCallback cb);

    bool SendControlMsg(Ptr<SatControlMessage> message, const Address& dest) const;

    void CnoInfoUpdated(Mac48Address utAddress, double cnoEstimate);

    Time GetDefaultFrameDuration() const;

    void SetDummyFrameSendingEnabled(bool dummyFrameSendingEnabled);

    virtual void ClearAllPackets();
 
  protected:
    typedef std::map<Mac48Address, Ptr<SatCnoEstimator>> CnoEstimatorMap_t;
 
    SatFwdLinkScheduler& operator=(const SatFwdLinkScheduler&);
    SatFwdLinkScheduler(const SatFwdLinkScheduler&);

    void DoDispose(void);

    virtual void ScheduleBbFrames() = 0;

    bool CnoMatchWithFrame(double cno, Ptr<SatBbFrame> frame) const;

    double GetSchedulingObjectCno(Ptr<SatSchedulingObject> ob);

    virtual void SendAndClearSymbolsSentStat() = 0;

    void PeriodicTimerExpired();

    void GetSchedulingObjects(std::vector<Ptr<SatSchedulingObject>>& output);

    void SortSchedulingObjects(std::vector<Ptr<SatSchedulingObject>>& so);

    Ptr<SatCnoEstimator> CreateCnoEstimator();

    Mac48Address m_macAddress;

    bool m_dummyFrameSendingEnabled;

    Ptr<UniformRandomVariable> m_random;

    Time m_periodicInterval;

    Ptr<SatBbFrameConf> m_bbFrameConf;

    ScheduleSortingCriteria_t m_additionalSortCriteria;

    SatFwdLinkScheduler::TxOpportunityCallback m_txOpportunityCallback;

    SatFwdLinkScheduler::SchedContextCallback m_schedContextCallback;

    SatFwdLinkScheduler::SendControlMsgCallback m_sendControlMsgCallback;

    CnoEstimatorMap_t m_cnoEstimatorContainer;

    SatCnoEstimator::EstimationMode_t m_cnoEstimatorMode;

    Time m_cnoEstimationWindow;

    double m_carrierBandwidthInHz;

    TracedCallback<uint8_t, double> m_schedulingSymbolRateTrace;
};
 
} // namespace ns3
 
#endif /* SAT_FWD_LINK_SCHEDULER_H */