satellite-random-access-container.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: Frans Laakso <frans.laakso@magister.fi>
 * Author: Mathias Ettinger <mettinger@toulouse.viveris.fr>
 */
 
#ifndef SATELLITE_RANDOM_ACCESS_H
#define SATELLITE_RANDOM_ACCESS_H
 
#include "satellite-enums.h"
#include "satellite-random-access-container-conf.h"
 
#include "ns3/object.h"
#include "ns3/random-variable-stream.h"
#include "ns3/simulator.h"
#include "ns3/uinteger.h"
 
#include <map>
#include <set>
#include <stdint.h>
#include <utility>
 
namespace ns3
{

class SatRandomAccess : public Object
{
  public:
    typedef Callback<bool> IsDamaAvailableCallback;

    typedef Callback<bool> AreBuffersEmptyCallback;

    typedef struct
    {
        SatEnums::RandomAccessTxOpportunityType_t txOpportunityType;
        uint32_t slottedAlohaTxOpportunity;
        std::map<uint32_t, std::set<uint32_t>> crdsaTxOpportunities;
        uint32_t allocationChannel;
    } RandomAccessTxOpportunities_s;

    SatRandomAccess();

    SatRandomAccess(Ptr<SatRandomAccessConf> randomAccessConf,
                    SatEnums::RandomAccessModel_t randomAccessModel);

    virtual ~SatRandomAccess();

    static TypeId GetTypeId(void);

    void SetRandomAccessModel(SatEnums::RandomAccessModel_t randomAccessModel);

    void SetCrdsaBackoffTimeInMilliSeconds(uint32_t allocationChannel,
                                           uint32_t backoffTimeInMilliSeconds);

    void SetCrdsaBackoffProbability(uint32_t allocationChannel, uint16_t backoffProbability);

    void SetCrdsaRandomizationParameters(uint32_t allocationChannel,
                                         uint32_t minRandomizationValue,
                                         uint32_t maxRandomizationValue,
                                         uint32_t numOfInstances);

    void SetCrdsaMaximumDataRateLimitationParameters(uint32_t allocationChannel,
                                                     uint32_t maxUniquePayloadPerBlock,
                                                     uint32_t maxConsecutiveBlocksAccessed,
                                                     uint32_t minIdleBlocks);

    void SetFSimBackoffTimeInFrames(uint32_t allocationChannel, uint32_t backoffTimeInFrames);

    void SetFSimBackoffProbability(uint32_t allocationChannel, uint16_t backoffPersistence);

    void SetBackoffTime(uint32_t allocationChannel, uint32_t backoffTime);

    void SetBackoffProbability(uint32_t allocationChannel, uint16_t backoffProbability);

    void SetSlottedAlohaControlRandomizationIntervalInMilliSeconds(
        uint32_t controlRandomizationIntervalInMilliSeconds);

    SatRandomAccess::RandomAccessTxOpportunities_s DoRandomAccess(
        uint32_t allocationChannel,
        SatEnums::RandomAccessTriggerType_t triggerType);

    void SetIsDamaAvailableCallback(SatRandomAccess::IsDamaAvailableCallback callback);

    void SetAreBuffersEmptyCallback(SatRandomAccess::AreBuffersEmptyCallback callback);

    uint32_t GetCrdsaSignalingOverheadInBytes();

    uint32_t GetSlottedAlohaSignalingOverheadInBytes();

    bool CrdsaHasBackoffTimePassed(uint32_t allocationChannel) const;
 
  protected:
    void DoDispose();
 
  private:
    void PrintVariables();

    uint32_t GetConfigurationIdForAllocationChannel(uint32_t allocationChannelId);

    SatRandomAccess::RandomAccessTxOpportunities_s DoEssa(uint32_t allocationChannel);

    SatRandomAccess::RandomAccessTxOpportunities_s DoSlottedAloha();

    uint32_t SlottedAlohaRandomizeReleaseTime();

    void SlottedAlohaDoVariableSanityCheck();

    SatRandomAccess::RandomAccessTxOpportunities_s DoCrdsa(uint32_t allocationChannel);

    bool CrdsaDoBackoff(uint32_t allocationChannel);

    std::pair<std::set<uint32_t>, std::set<uint32_t>> CrdsaRandomizeTxOpportunities(
        uint32_t allocationChannel,
        std::pair<std::set<uint32_t>, std::set<uint32_t>> slots);

    SatRandomAccess::RandomAccessTxOpportunities_s CrdsaPrepareToTransmit(
        uint32_t allocationChannel);

    void CrdsaSetBackoffTimer(uint32_t allocationChannel);

    void CrdsaIncreaseConsecutiveBlocksUsed(uint32_t allocationChannel);

    void CrdsaIncreaseConsecutiveBlocksUsedForAllAllocationChannels();

    void CrdsaReduceIdleBlocks(uint32_t allocationChannel);

    void CrdsaReduceIdleBlocksForAllAllocationChannels();

    void CrdsaResetConsecutiveBlocksUsedForAllAllocationChannels();

    void CrdsaResetConsecutiveBlocksUsed(uint32_t allocationChannel);

    bool CrdsaIsAllocationChannelFree(uint32_t allocationChannel);

    bool IsCrdsaAllocationChannel(uint32_t allocationChannel);

    bool IsSlottedAlohaAllocationChannel(uint32_t allocationChannel);

    bool IsEssaAllocationChannel(uint32_t allocationChannel);

    Ptr<UniformRandomVariable> m_uniformRandomVariable;

    SatEnums::RandomAccessModel_t m_randomAccessModel;

    Ptr<SatRandomAccessConf> m_randomAccessConf;

    uint32_t m_numOfAllocationChannels;

    bool m_crdsaNewData;

    IsDamaAvailableCallback m_isDamaAvailableCb;

    AreBuffersEmptyCallback m_areBuffersEmptyCb;
};
 
} // namespace ns3
 
#endif /* SATELLITE_RANDOM_ACCESS_H */