satellite-random-access-container-conf.cc

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>
 */
 
#include "satellite-random-access-container-conf.h"
 
#include <ns3/double.h>
#include <ns3/log.h>
#include <ns3/uinteger.h>
 
#include <limits>
#include <map>
#include <utility>
 
NS_LOG_COMPONENT_DEFINE("SatRandomAccessConf");
 
namespace ns3
{
 
NS_OBJECT_ENSURE_REGISTERED(SatRandomAccessConf);
 
TypeId
SatRandomAccessConf::GetTypeId(void)
{
    static TypeId tid =
        TypeId("ns3::SatRandomAccessConf")
            .SetParent<Object>()
            .AddConstructor<SatRandomAccessConf>()
            .AddAttribute(
                "CrdsaSignalingOverheadInBytes",
                "CRDSA signaling overhead in bytes.",
                UintegerValue(5),
                MakeUintegerAccessor(&SatRandomAccessConf::m_crdsaSignalingOverheadInBytes),
                MakeUintegerChecker<uint32_t>())
            .AddAttribute(
                "SlottedAlohaSignalingOverheadInBytes",
                "Slotted ALOHA signaling overhead in bytes.",
                UintegerValue(3),
                MakeUintegerAccessor(&SatRandomAccessConf::m_slottedAlohaSignalingOverheadInBytes),
                MakeUintegerChecker<uint32_t>());
    return tid;
}
 
SatRandomAccessConf::SatRandomAccessConf()
    : m_slottedAlohaControlRandomizationIntervalInMilliSeconds(),
      m_allocationChannelCount(),
      m_crdsaSignalingOverheadInBytes(),
      m_slottedAlohaSignalingOverheadInBytes()
{
    NS_LOG_FUNCTION(this);
    NS_FATAL_ERROR("SatRandomAccessConf::SatRandomAccessConf - Constructor not in use");
}
 
SatRandomAccessConf::SatRandomAccessConf(Ptr<SatLowerLayerServiceConf> llsConf,
                                         Ptr<SatSuperframeSeq> superframeSeq)
    : m_configurationIdPerAllocationChannel(),
      m_slottedAlohaControlRandomizationIntervalInMilliSeconds(),
      m_allocationChannelCount(llsConf->GetRaServiceCount()),
      m_crdsaSignalingOverheadInBytes(5),
      m_slottedAlohaSignalingOverheadInBytes(3)
{
    NS_LOG_FUNCTION(this);
 
    if (m_allocationChannelCount < 1)
    {
        NS_FATAL_ERROR(
            "SatRandomAccessConf::SatRandomAccessConf - No random access allocation channel");
    }
 
    m_slottedAlohaControlRandomizationIntervalInMilliSeconds =
        (llsConf->GetDefaultControlRandomizationInterval()).GetMilliSeconds();
    DoSlottedAlohaVariableSanityCheck();
 
    for (uint32_t i = 0; i < m_allocationChannelCount; i++)
    {
        Ptr<SatRandomAccessAllocationChannel> allocationChannel =
            CreateObject<SatRandomAccessAllocationChannel>();
        m_allocationChannelConf.insert(std::make_pair(i, allocationChannel));
 
        allocationChannel->SetSlottedAlohaAllowed(llsConf->GetRaIsSlottedAlohaAllowed(i));
        allocationChannel->SetCrdsaAllowed(llsConf->GetRaIsCrdsaAllowed(i));
        allocationChannel->SetEssaAllowed(llsConf->GetRaIsEssaAllowed(i));
        allocationChannel->SetCrdsaMaxUniquePayloadPerBlock(
            llsConf->GetRaMaximumUniquePayloadPerBlock(i));
        allocationChannel->SetCrdsaMaxConsecutiveBlocksAccessed(
            llsConf->GetRaMaximumConsecutiveBlockAccessed(i));
        allocationChannel->SetCrdsaMinIdleBlocks(llsConf->GetRaMinimumIdleBlock(i));
        allocationChannel->SetCrdsaNumOfInstances(llsConf->GetRaNumberOfInstances(i));
        allocationChannel->SetCrdsaBackoffProbability(llsConf->GetRaBackOffProbability(i));
        allocationChannel->SetCrdsaBackoffTimeInMilliSeconds(
            llsConf->GetRaBackOffTimeInMilliSeconds(i));
        allocationChannel->SetFSimBackoffProbability(llsConf->GetRaBackOffProbability(i));
        allocationChannel->SetFSimBackoffTimeInMilliSeconds(
            llsConf->GetRaBackOffTimeInMilliSeconds(i));
        allocationChannel->SetFSimPhysicalLayerFrameInMilliSeconds(
            (superframeSeq->GetSuperframeConf(0)->GetDuration()).GetMilliSeconds());
 
        allocationChannel->SetCrdsaMinRandomizationValue(0);
        allocationChannel->SetCrdsaMaxRandomizationValue(std::numeric_limits<uint16_t>::max());
    }
 
    Ptr<SatSuperframeConf> superframeConf = superframeSeq->GetSuperframeConf(0);
    for (uint32_t i = 0; i < superframeConf->GetRaChannelCount(); ++i)
    {
        uint8_t allocationChannel = superframeConf->GetRaChannelAllocationChannelId(i);
        uint16_t raSlotCount = superframeConf->GetRaSlotCount(i) - 1;
 
        if (allocationChannel < m_allocationChannelCount)
        {
            m_configurationIdPerAllocationChannel.push_back(allocationChannel);
            auto allocationChannelConf = m_allocationChannelConf[allocationChannel];
            if (raSlotCount < allocationChannelConf->GetCrdsaMaxRandomizationValue())
            {
                allocationChannelConf->SetCrdsaMaxRandomizationValue(raSlotCount);
            }
        }
        else
        {
            NS_FATAL_ERROR("Allocation channel for frame " << superframeConf->GetRaChannelFrameId(i)
                                                           << " is out of range");
        }
    }
 
    for (auto& allocationChannelConf : m_allocationChannelConf)
    {
        if (allocationChannelConf.second->GetCrdsaAllowed())
        {
            allocationChannelConf.second->DoCrdsaVariableSanityCheck();
        }
    }
}
 
SatRandomAccessConf::~SatRandomAccessConf()
{
    NS_LOG_FUNCTION(this);
}
 
Ptr<SatRandomAccessAllocationChannel>
SatRandomAccessConf::GetAllocationChannelConfiguration(uint32_t allocationChannel)
{
    NS_LOG_FUNCTION(this << allocationChannel);
 
    std::map<uint32_t, Ptr<SatRandomAccessAllocationChannel>>::iterator iter =
        m_allocationChannelConf.find(allocationChannel);
 
    if (iter == m_allocationChannelConf.end())
    {
        NS_FATAL_ERROR(
            "SatRandomAccessConf::GetAllocationChannelConfiguration - Invalid allocation channel");
    }
 
    return (iter->second);
}
 
void
SatRandomAccessConf::DoSlottedAlohaVariableSanityCheck()
{
    NS_LOG_FUNCTION(this);
 
    if (m_slottedAlohaControlRandomizationIntervalInMilliSeconds < 1)
    {
        NS_FATAL_ERROR("SatRandomAccessConf::DoSlottedAlohaVariableSanityCheck - "
                       "m_slottedAlohaControlRandomizationIntervalInMilliSeconds < 1");
    }
 
    NS_LOG_INFO("Variable sanity check done");
}
 
uint32_t
SatRandomAccessConf::GetAllocationChannelConfigurationId(uint32_t allocationChannel)
{
    NS_LOG_FUNCTION(this << allocationChannel);
 
    if (allocationChannel >= m_configurationIdPerAllocationChannel.size())
    {
        NS_FATAL_ERROR(
            "SatRandomAccessConf::GetAllocationChannelConfigurationId - allocation channel "
            << allocationChannel << " has no associated configuration.");
    }
 
    return m_configurationIdPerAllocationChannel[allocationChannel];
}
 
} // namespace ns3