satellite-phy-rx-carrier-per-window.cc

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * 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: Joaquin Muguerza <jmuguerza@toulouse.viveris.fr>
 */
 
#include "satellite-phy-rx-carrier-per-window.h"
 
#include "satellite-link-results.h"
#include "satellite-mutual-information-table.h"
#include "satellite-uplink-info-tag.h"
#include "satellite-utils.h"
#include "satellite-wave-form-conf.h"
 
#include <ns3/boolean.h>
#include <ns3/double.h>
#include <ns3/log.h>
#include <ns3/simulator.h>
 
#include <algorithm>
#include <iomanip>
#include <limits>
#include <ostream>
#include <utility>
 
NS_LOG_COMPONENT_DEFINE("SatPhyRxCarrierPerWindow");
 
namespace ns3
{
 
NS_OBJECT_ENSURE_REGISTERED(SatPhyRxCarrierPerWindow);
 
SatPhyRxCarrierPerWindow::SatPhyRxCarrierPerWindow(uint32_t carrierId,
                                                   Ptr<SatPhyRxCarrierConf> carrierConf,
                                                   Ptr<SatWaveformConf> waveformConf,
                                                   bool randomAccessEnabled)
    : SatPhyRxCarrierPerSlot(carrierId, carrierConf, waveformConf, randomAccessEnabled),
      m_windowDuration(MilliSeconds(60)),
      m_windowStep(MilliSeconds(20)),
      m_windowDelay(Seconds(0)),
      m_firstWindow(Seconds(0)),
      m_windowSicIterations(10),
      m_spreadingFactor(0),
      m_windowEndSchedulingInitialized(false),
      m_detectionThreshold(0.0),
      m_sicEnabled(true)
{
    NS_LOG_FUNCTION(this);
    NS_LOG_INFO("Constructor called with arguments " << carrierId << ", " << carrierConf << ", and "
                                                     << randomAccessEnabled);
 
    NS_ASSERT(m_randomAccessEnabled == true);
}
 
void
SatPhyRxCarrierPerWindow::BeginEndScheduling()
{
    NS_LOG_FUNCTION(this);
    if (!m_windowEndSchedulingInitialized)
    {
        if (GetNodeInfo() == NULL)
        {
            NS_FATAL_ERROR("SatPhyRxWindow::BeginWindowEndScheduling - m_nodeInfo not set");
        }
 
        m_windowEndSchedulingInitialized = true;
 
        Simulator::ScheduleWithContext(GetNodeInfo()->GetNodeId(),
                                       m_firstWindow + m_windowDuration,
                                       &SatPhyRxCarrierPerWindow::DoWindowEnd,
                                       this);
    }
}
 
SatPhyRxCarrierPerWindow::~SatPhyRxCarrierPerWindow()
{
    NS_LOG_FUNCTION(this);
}
 
TypeId
SatPhyRxCarrierPerWindow::GetTypeId(void)
{
    static TypeId tid =
        TypeId("ns3::SatPhyRxCarrierPerWindow")
            .SetParent<SatPhyRxCarrierPerSlot>()
            .AddAttribute("WindowDuration",
                          "The duration of the sliding window",
                          TimeValue(MilliSeconds(60)),
                          MakeTimeAccessor(&SatPhyRxCarrierPerWindow::m_windowDuration),
                          MakeTimeChecker())
            .AddAttribute("WindowStep",
                          "The length of the step between two window iterations",
                          TimeValue(MilliSeconds(20)),
                          MakeTimeAccessor(&SatPhyRxCarrierPerWindow::m_windowStep),
                          MakeTimeChecker())
            .AddAttribute(
                "WindowDelay",
                "The delay before processing a sliding window, waiting for incomplete packets",
                TimeValue(Seconds(0)),
                MakeTimeAccessor(&SatPhyRxCarrierPerWindow::m_windowDelay),
                MakeTimeChecker())
            .AddAttribute("FirstWindow",
                          "The time at which the first window is processed",
                          TimeValue(Seconds(0)),
                          MakeTimeAccessor(&SatPhyRxCarrierPerWindow::m_firstWindow),
                          MakeTimeChecker())
            .AddAttribute("WindowSICIterations",
                          "The number of SIC iterations performed on each window",
                          UintegerValue(10),
                          MakeUintegerAccessor(&SatPhyRxCarrierPerWindow::m_windowSicIterations),
                          MakeUintegerChecker<uint32_t>())
            // TODO: this shouldn't be here!! find a way to retrieve SF from SuperFrameConf,
            // maybe store SF in waveform.
            .AddAttribute("SpreadingFactor",
                          "The spreading factor of the packets",
                          UintegerValue(1),
                          MakeUintegerAccessor(&SatPhyRxCarrierPerWindow::m_spreadingFactor),
                          MakeUintegerChecker<uint32_t>())
            .AddAttribute("DetectionThreshold",
                          "The SNIR Detection Threshold (in magnitude) for a packet",
                          DoubleValue(0.0),
                          MakeDoubleAccessor(&SatPhyRxCarrierPerWindow::m_detectionThreshold),
                          MakeDoubleChecker<double>(0, std::numeric_limits<double>::max()))
            .AddAttribute("EnableSIC",
                          "Use SIC when decoding a packet",
                          BooleanValue(true),
                          MakeBooleanAccessor(&SatPhyRxCarrierPerWindow::m_sicEnabled),
                          MakeBooleanChecker())
            .AddTraceSource(
                "EssaRxCollision",
                "Received a packet through Random Access ESSA",
                MakeTraceSourceAccessor(&SatPhyRxCarrierPerWindow::m_essaRxCollisionTrace),
                "ns3::SatPhyRxCarrierPacketProbe::RxStatusCallback")
            .AddTraceSource("EssaRxError",
                            "Received a packet through Random Access ESSA",
                            MakeTraceSourceAccessor(&SatPhyRxCarrierPerWindow::m_essaRxErrorTrace),
                            "ns3::SatPhyRxCarrierPacketProbe::RxStatusCallback")
            .AddTraceSource("WindowLoad",
                            "Performed a window load measurement",
                            MakeTraceSourceAccessor(&SatPhyRxCarrierPerWindow::m_windowLoadTrace),
                            "ns3::SatPhyRxCarrierPerWindow::WindowLoadTraceCallback");
    return tid;
}
 
void
SatPhyRxCarrierPerWindow::DoDispose()
{
    SatPhyRxCarrierPerSlot::DoDispose();
}
 
void
SatPhyRxCarrierPerWindow::ReceiveSlot(SatPhyRxCarrier::rxParams_s packetRxParams,
                                      const uint32_t nPackets)
{
    NS_ASSERT(packetRxParams.rxParams->m_txInfo.packetType !=
              SatEnums::PACKET_TYPE_DEDICATED_ACCESS);
 
    if (packetRxParams.rxParams->m_txInfo.packetType != SatEnums::PACKET_TYPE_ESSA)
    {
        NS_LOG_ERROR("SatPhyRxCarrierPerWindow::ReceiveSlot - Time: "
                     << Now().GetSeconds() << " - Non ESSA packet received");
        return;
    }
 
    NS_LOG_INFO("SatPhyRxCarrierPerWindow::ReceiveSlot - Time: " << Now().GetSeconds()
                                                                 << " - ESSA packet received");
 
    SatPhyRxCarrierPerWindow::essaPacketRxParams_s params;
 
    params.destAddress = packetRxParams.destAddress;
    params.sourceAddress = packetRxParams.sourceAddress;
    params.duration = packetRxParams.rxParams->m_duration;
    params.arrivalTime = Now() - params.duration; // arrival time is the start of reception
    params.rxParams = packetRxParams.rxParams;
    params.hasBeenDecoded = false;
    params.failedSic = false;
    params.hasBeenUpdated = false;
    params.isInsideWindow = false;
    params.meanSinr = -1.0;
    params.preambleMeanSinr = -1.0;
 
    // Calculate SINR, gamma and ifPowerPerFragment
    CalculatePacketInterferenceVectors(params);
 
    // Check if packet can be detected
    if (!PacketCanBeDetected(params))
    {
        NS_LOG_INFO("SatPhyRxCarrierPerWindow::ReceiveSlot - Packet "
                    << params.rxParams->m_txInfo.crdsaUniquePacketId << " from "
                    << params.sourceAddress << " cannot be detected. Ignore it.");
        m_essaRxCollisionTrace(1,                    // number of packets
                               params.sourceAddress, // sender address
                               1);                   // error flag
        return;
    }
 
    // Eliminate interference from already decoded packets
    // WARNING: with some combinations of window size and step, it may be possible that
    // previously decoded packets have already been cleaned.
    EliminatePreviousInterferences(params);
 
    // Calculate SINR, gamma and ifPowerPerFragment
    CalculatePacketInterferenceVectors(params);
 
    AddEssaPacket(params);
}
 
void
SatPhyRxCarrierPerWindow::EliminatePreviousInterferences(
    SatPhyRxCarrierPerWindow::essaPacketRxParams_s& packet)
{
    NS_LOG_FUNCTION(this);
 
    if (!m_sicEnabled)
    {
        return;
    }
 
    NS_LOG_INFO("SatPhyRxCarrierPerWindow::EliminatePreviousInterferences - Eliminate "
                "interferences from packet "
                << packet.rxParams->m_txInfo.crdsaUniquePacketId << " from "
                << packet.sourceAddress);
 
    // Get which packets that have been decoded interfere with this packet
    packetList_t::iterator packet_it;
    for (packet_it = m_essaPacketContainer.begin(); packet_it != m_essaPacketContainer.end();
         packet_it++)
    {
        if ((packet_it->arrivalTime + packet_it->duration) <= packet.arrivalTime)
        {
            continue;
        }
        if (!(packet_it->hasBeenDecoded))
        {
            continue;
        }
        std::pair<double, double> normalizedTimes =
            GetNormalizedPacketInterferenceTime(packet, *packet_it);
 
        NS_LOG_INFO("SatPhyRxCarrierPerWindow::EliminatePreviousInterferences - eliminate "
                    "interference with packet "
                    << packet_it->rxParams->m_txInfo.crdsaUniquePacketId << " from "
                    << packet_it->sourceAddress);
        GetInterferenceEliminationModel()->EliminateInterferences(
            packet.rxParams,
            packet_it->rxParams,
            packet_it->meanSinr * m_spreadingFactor,
            m_linkRegenerationMode != SatEnums::TRANSPARENT,
            normalizedTimes.first,
            normalizedTimes.second);
    }
}
 
void
SatPhyRxCarrierPerWindow::CalculatePacketInterferenceVectors(
    SatPhyRxCarrierPerWindow::essaPacketRxParams_s& packet)
{
    NS_LOG_FUNCTION(this);
    NS_LOG_INFO("SatPhyRxCarrierPerWindow::CalculatePacketInterferenceVectors - Packet "
                << packet.rxParams->m_txInfo.crdsaUniquePacketId << " from "
                << packet.sourceAddress);
 
    // TODO: should we check the interference model used ?
    // TODO: should we check the collision model used (check against sinr, collision always drops,
    // etc) ?
 
    double snr = CalculateSinr(packet.rxParams->m_rxPower_W,
                               0.0,
                               m_rxNoisePowerW,
                               m_rxAciIfPowerW,
                               m_rxExtNoisePowerW,
                               m_additionalInterferenceCallback());
 
    double cSnr;
    if (GetLinkRegenerationMode() == SatEnums::TRANSPARENT)
    {
        double snrSatellite = CalculateSinr(packet.rxParams->GetRxPowerInSatellite(),
                                            0.0,
                                            packet.rxParams->GetRxNoisePowerInSatellite(),
                                            packet.rxParams->GetRxAciIfPowerInSatellite(),
                                            packet.rxParams->GetRxExtNoisePowerInSatellite(),
                                            packet.rxParams->GetAdditionalInterference());
 
        cSnr = CalculateCompositeSinr(snr, snrSatellite);
    }
    else
    {
        cSnr = snr;
    }
 
    if (packet.meanSinr < 0.0)
    {
        SatSignalParameters::PacketsInBurst_t packets = packet.rxParams->m_packetsInBurst;
        SatSignalParameters::PacketsInBurst_t::const_iterator i;
        for (i = packets.begin(); i != packets.end(); i++)
        {
            SatUplinkInfoTag satUplinkInfoTag;
            (*i)->RemovePacketTag(satUplinkInfoTag);
            satUplinkInfoTag.SetSinr(snr, m_additionalInterferenceCallback());
            (*i)->AddPacketTag(satUplinkInfoTag);
        }
 
        // Update link specific SINR trace
        m_linkSinrTrace(SatUtils::LinearToDb(snr), packet.sourceAddress);
 
        // Update composite SNR trace for DAMA and Slotted ALOHA packets
        // m_sinrTrace (SatUtils::LinearToDb (cSnr), packet.sourceAddress); // Done with effective
        // SINR
 
        m_linkBudgetTrace(packet.rxParams, GetOwnAddress(), packet.destAddress, 0.0, cSnr);
 
        if (IsCompositeSinrOutputTraceEnabled())
        {
            DoCompositeSinrOutputTrace(cSnr);
        }
 
        NS_LOG_INFO("SatPhyRxCarrierPerWindow::CalculatePacketInterferenceVectors - Received "
                    "packet SNR dB = "
                    << SatUtils::LinearToDb(cSnr));
    }
 
    packet.gamma.clear();
 
    std::vector<std::pair<double, double>> interferencePowerPerFragment =
        packet.rxParams->GetInterferencePowerPerFragment();
    std::vector<std::pair<double, double>>::iterator interferencePower =
        interferencePowerPerFragment.begin();
    double normalizedTime = interferencePower->first, normalizedTimeInSatellite = 0.0;
    if (GetLinkRegenerationMode() == SatEnums::TRANSPARENT)
    {
        std::vector<std::pair<double, double>> interferencePowerPerFragmentInSatellite =
            packet.rxParams->GetInterferencePowerInSatellitePerFragment();
        for (std::vector<std::pair<double, double>>::iterator interferencePowerInSatellite =
                 interferencePowerPerFragmentInSatellite.begin();
             interferencePowerInSatellite != interferencePowerPerFragmentInSatellite.end();
             interferencePowerInSatellite++)
        {
            normalizedTimeInSatellite += interferencePowerInSatellite->first;
            if (normalizedTimeInSatellite > normalizedTime)
            {
                interferencePower++;
                normalizedTime += interferencePower->first;
            }
 
 
            double cI = (packet.rxParams->GetRxPowerInSatellite() * packet.rxParams->m_rxPower_W) /
                        (interferencePowerInSatellite->second * packet.rxParams->m_rxPower_W +
                         interferencePower->second * packet.rxParams->GetRxPowerInSatellite());
 
            double gamma = 1 / (1 / cI + 1 / cSnr);
            packet.gamma.emplace_back(interferencePowerInSatellite->first, gamma);
        }
    }
    else
    {
 
        double cI = (packet.rxParams->m_rxPower_W) /
                    (packet.rxParams->m_rxPower_W + interferencePower->second);
 
        double gamma = 1 / (1 / cI + 1 / cSnr);
        packet.gamma.emplace_back(1, gamma);
    }
 
    std::vector<std::pair<double, double>> gammaPreamble;
    Ptr<SatWaveform> wf = GetWaveformConf()->GetWaveform(packet.rxParams->m_txInfo.waveformId);
    normalizedTime = 0.0;
    double normalizedPreambleTime =
        wf->GetPreambleLengthInSymbols() /
        wf->GetBurstLengthInSymbols(); // This asumes that preamble and burst have the same symbol
                                       // rate
    for (std::vector<std::pair<double, double>>::iterator it = packet.gamma.begin();
         it != packet.gamma.end();
         it++)
    {
        if (normalizedTime + it->first > normalizedPreambleTime)
        {
            gammaPreamble.emplace_back(1.0 - normalizedTime, it->second);
            break;
        }
        gammaPreamble.emplace_back(it->first / normalizedPreambleTime, it->second);
        normalizedTime += it->first;
    }
 
    packet.meanSinr = SatUtils::ScalarProduct(packet.gamma);
    packet.preambleMeanSinr = SatUtils::ScalarProduct(gammaPreamble);
 
    packet.hasBeenUpdated = true;
}
 
void
SatPhyRxCarrierPerWindow::DoWindowEnd()
{
    NS_LOG_FUNCTION(this);
    NS_LOG_INFO("SatPhyRxCarrierPerWindow::DoWindowEnd");
 
    // ProcessWindow (Now () - m_windowDuration, Now ());
    Simulator::Schedule(m_windowDelay,
                        &SatPhyRxCarrierPerWindow::ProcessWindow,
                        this,
                        Now() - m_windowDuration,
                        Now());
 
    // Advance the window (schedule DoWindowEnd for m_windowStep)
    Simulator::Schedule(m_windowStep, &SatPhyRxCarrierPerWindow::DoWindowEnd, this);
}
 
void
SatPhyRxCarrierPerWindow::ProcessWindow(Time startTime, Time endTime)
{
    NS_LOG_INFO("SatPhyRxCarrierPerWindow::DoProcessWindow - Process window between "
                << startTime.GetSeconds() << " and " << endTime.GetSeconds());
 
    CleanOldPackets(startTime);
 
    std::pair<packetList_t::iterator, packetList_t::iterator> windowBounds =
        GetWindowBounds(startTime, endTime);
 
    uint32_t i = 0;
    while (i < m_windowSicIterations)
    {
        while (true)
        {
            packetList_t::iterator packet_it = GetHighestSnirPacket(windowBounds);
            if (packet_it == windowBounds.second)
            {
                NS_LOG_INFO("SatPhyRxCarrierPerWindow::DoWindowEnd - No more packets to decode");
                break;
            }
            packet_it->hasBeenTreatedInWindow = true;
 
            NS_LOG_INFO("SatPhyRxCarrierPerWindow::DoWindowEnd - Process packet "
                        << packet_it->rxParams->m_txInfo.crdsaUniquePacketId << " from "
                        << packet_it->sourceAddress);
            packet_it->hasBeenUpdated = false;
            double sinrEffective = GetEffectiveSnir(*packet_it);
            m_sinrTrace(SatUtils::LinearToDb(sinrEffective), packet_it->sourceAddress);
            bool phyError = CheckAgainstLinkResults(sinrEffective, packet_it->rxParams);
            // Trace if the packet has been decoded or not
            m_essaRxErrorTrace(1,                        // number of packets
                               packet_it->sourceAddress, // sender address
                               phyError);                // error flag
            if (!phyError)
            {
                packet_it->hasBeenDecoded = true;
                DoSic(packet_it, windowBounds);
                NS_LOG_WARN("received " << packet_it->sourceAddress << " "
                                        << packet_it->rxParams->m_txInfo.crdsaUniquePacketId << " "
                                        << " INFO " << *(packet_it->rxParams->m_packetsInBurst[0]));
            }
            else
            {
                NS_LOG_INFO("Failed to decode packet "
                            << packet_it->sourceAddress << "-"
                            << packet_it->rxParams->m_txInfo.crdsaUniquePacketId);
                packet_it->failedSic = true;
            }
        }
 
        // increase iteration number
        i++;
    }
    for (packetList_t::iterator packet_it = windowBounds.first; packet_it != windowBounds.second;
         packet_it++)
    {
        if (!packet_it->isInsideWindow || !packet_it->hasBeenTreatedInWindow)
        {
            continue;
        }
        m_rxCallback(packet_it->rxParams, !packet_it->hasBeenDecoded);
    }
    if (IsRandomAccessDynamicLoadControlEnabled())
    {
        MeasureRandomAccessLoad();
    }
    NS_LOG_INFO("SatPhyRxCarrierPerWindow::DoWindowEnd - Window processing finished");
}
 
void
SatPhyRxCarrierPerWindow::DoSic(
    packetList_t::iterator processedPacket,
    std::pair<packetList_t::iterator, packetList_t::iterator> windowBounds)
{
    NS_LOG_FUNCTION(this);
 
    if (!m_sicEnabled)
    {
        return;
    }
 
    NS_LOG_INFO("SatPhyRxCarrierPerWindow::DoSic - eliminate interference from packet "
                << processedPacket->rxParams->m_txInfo.crdsaUniquePacketId << " from "
                << processedPacket->sourceAddress);
 
    for (packetList_t::iterator packet_it = windowBounds.first; packet_it != windowBounds.second;
         packet_it++)
    {
        if (packet_it->arrivalTime >= processedPacket->arrivalTime + processedPacket->duration)
        {
            break;
        }
        if (packet_it->arrivalTime + packet_it->duration <= processedPacket->arrivalTime)
        {
            continue;
        }
        if (packet_it == processedPacket || packet_it->hasBeenDecoded)
        {
            continue;
        }
        NS_LOG_INFO("SatPhyRxCarrierPerWindow::DoSic - eliminate interference with packet "
                    << packet_it->rxParams->m_txInfo.crdsaUniquePacketId << " from "
                    << packet_it->sourceAddress);
        std::pair<double, double> normalizedTimes =
            GetNormalizedPacketInterferenceTime(*packet_it, *processedPacket);
        GetInterferenceEliminationModel()->EliminateInterferences(
            packet_it->rxParams,
            processedPacket->rxParams,
            processedPacket->meanSinr * m_spreadingFactor,
            m_linkRegenerationMode != SatEnums::TRANSPARENT,
            normalizedTimes.first,
            normalizedTimes.second);
 
        CalculatePacketInterferenceVectors(*packet_it);
    }
}
 
std::pair<double, double>
SatPhyRxCarrierPerWindow::GetNormalizedPacketInterferenceTime(
    const SatPhyRxCarrierPerWindow::essaPacketRxParams_s& packet,
    const SatPhyRxCarrierPerWindow::essaPacketRxParams_s& interferingPacket)
{
    NS_LOG_FUNCTION(this);
 
    double startTimeA =
        std::max(0.0,
                 1.0 - ((packet.duration.GetDouble() + packet.arrivalTime.GetDouble() -
                         interferingPacket.arrivalTime.GetDouble()) /
                        packet.duration.GetDouble()));
    double endTimeA = std::min(
        1.0,
        1.0 - (packet.arrivalTime.GetDouble() - interferingPacket.arrivalTime.GetDouble()) /
                  packet.duration.GetDouble());
    double startTimeB =
        std::max(0.0,
                 (interferingPacket.arrivalTime.GetDouble() - packet.arrivalTime.GetDouble()) /
                     packet.duration.GetDouble());
    double endTimeB =
        std::min(1.0,
                 2.0 - (packet.arrivalTime.GetDouble() - interferingPacket.arrivalTime.GetDouble() +
                        packet.duration.GetDouble()) /
                           packet.duration.GetDouble());
 
    //  some rounding errors)
    double normalizedTime = 0.0;
    double exactStartTime = (startTimeA == 0.0) ? 0.0 : -1.0;
    double exactEndTime = -1.0;
    auto ifPowerPerFragment = packet.rxParams->GetInterferencePowerInSatellitePerFragment();
    for (std::pair<double, double>& ifPower : ifPowerPerFragment)
    {
        normalizedTime += ifPower.first;
        if ((exactStartTime < 0) && (normalizedTime == startTimeA || normalizedTime == startTimeB))
        {
            exactStartTime = normalizedTime;
        }
        if ((exactEndTime < 0) && (normalizedTime == endTimeA || normalizedTime == endTimeB))
        {
            exactEndTime = normalizedTime;
        }
    }
 
    if ((exactStartTime < 0) || (exactEndTime < 0))
    {
        NS_FATAL_ERROR("Cannot find exact interference time between two packets");
    }
 
    return std::make_pair(exactStartTime, exactEndTime);
}
 
double
SatPhyRxCarrierPerWindow::GetEffectiveSnir(
    const SatPhyRxCarrierPerWindow::essaPacketRxParams_s& packet)
{
    NS_LOG_FUNCTION(this);
 
    Ptr<SatLinkResultsRtn> satLinkResults = GetLinkResults()->GetObject<SatLinkResultsFSim>();
    Ptr<SatMutualInformationTable> mutualInformationTable;
    if (satLinkResults != NULL)
    {
        mutualInformationTable =
            (GetLinkResults()->GetObject<SatLinkResultsFSim>())->GetMutualInformationTable();
    }
    else
    {
        mutualInformationTable =
            (GetLinkResults()->GetObject<SatLinkResultsLora>())->GetMutualInformationTable();
    }
    double beta = mutualInformationTable->GetBeta();
 
    double meanMutualInformation = 0.0;
    for (std::vector<std::pair<double, double>>::const_iterator it = packet.gamma.begin();
         it != packet.gamma.end();
         it++)
    {
        meanMutualInformation += it->first * mutualInformationTable->GetNormalizedSymbolInformation(
                                                 SatUtils::LinearToDb(it->second / beta));
    }
 
    double effectiveSnir =
        beta * SatUtils::DbToLinear(mutualInformationTable->GetSnirDb(meanMutualInformation));
 
    NS_LOG_INFO("SatPhyRxCarrierPerWindow::GetEffectiveSnir - Packet "
                << packet.rxParams->m_txInfo.crdsaUniquePacketId << " from " << packet.sourceAddress
                << " - Effective SNIR dB: " << SatUtils::LinearToDb(effectiveSnir));
 
    return effectiveSnir;
}
 
void
SatPhyRxCarrierPerWindow::CleanOldPackets(const Time windowStartTime)
{
    NS_LOG_FUNCTION(this);
    NS_LOG_INFO("SatPhyRxCarrierPerWindow::CleanOldPackets");
 
    packetList_t::iterator it = m_essaPacketContainer.begin();
    while (it != m_essaPacketContainer.end())
    {
        Time offset = it->arrivalTime - windowStartTime;
        if (offset.IsStrictlyPositive())
        {
            break;
        }
        offset = it->arrivalTime + it->duration - windowStartTime;
        if (!offset.IsStrictlyPositive())
        {
            // Only trace packets that arrived after first Window
            if (it->arrivalTime >= m_firstWindow)
            {
                if (!(it->hasBeenDecoded))
                {
                }
                else
                {
                    m_daRxTrace(1,                 // number of packets
                                it->sourceAddress, // sender address
                                it->failedSic      // error flag
                    );
                }
                // Trace if the packet has been decoded or not
                m_essaRxCollisionTrace(1,                      // number of packets
                                       it->sourceAddress,      // sender address
                                       !(it->hasBeenDecoded)); // error flag
            }
            // Delete element from list
            NS_LOG_INFO("SatPhyRxCarrierPerWindow::CleanOldPackets - Remove packet "
                        << it->rxParams->m_txInfo.crdsaUniquePacketId << " from "
                        << it->sourceAddress);
            it->rxParams = NULL;
            m_essaPacketContainer.erase(it++);
        }
        else
        {
            ++it;
        }
    }
}
 
std::pair<SatPhyRxCarrierPerWindow::packetList_t::iterator,
          SatPhyRxCarrierPerWindow::packetList_t::iterator>
SatPhyRxCarrierPerWindow::GetWindowBounds(Time startTime, Time endTime)
{
    NS_LOG_FUNCTION(this);
    NS_LOG_INFO("SatPhyRxCarrierPerWindow::GetWindowBounds");
 
    packetList_t::iterator last;
    m_payloadBytesInWindow = 0;
 
    for (last = m_essaPacketContainer.begin(); last != m_essaPacketContainer.end(); last++)
    {
        last->isInsideWindow = false;
        if (last->arrivalTime > endTime)
        {
            break;
        }
        if ((last->arrivalTime >= startTime) && (last->arrivalTime + last->duration <= endTime))
        {
            last->isInsideWindow = true;
            last->hasBeenTreatedInWindow = false;
            m_payloadBytesInWindow += GetWaveformConf()
                                          ->GetWaveform(last->rxParams->m_txInfo.waveformId)
                                          ->GetPayloadInBytes();
        }
 
        NS_LOG_INFO("SatPhyRxCarrierPerWindow::GetWindowBounds - Packet "
                    << last->rxParams->m_txInfo.crdsaUniquePacketId << " from "
                    << last->sourceAddress << " is inside the window");
    }
 
    return std::make_pair(m_essaPacketContainer.begin(), last);
}
 
SatPhyRxCarrierPerWindow::packetList_t::iterator
SatPhyRxCarrierPerWindow::GetHighestSnirPacket(
    const std::pair<SatPhyRxCarrierPerWindow::packetList_t::iterator,
                    SatPhyRxCarrierPerWindow::packetList_t::iterator> windowBounds)
{
    NS_LOG_FUNCTION(this);
    NS_LOG_INFO("SatPhyRxCarrierPerWindow::GetHighestSnirPacket");
 
    SatPhyRxCarrierPerWindow::packetList_t::iterator it, max = windowBounds.second;
    for (it = windowBounds.first; it != windowBounds.second; it++)
    {
        if (it->hasBeenDecoded || !(it->hasBeenUpdated) || !(it->isInsideWindow))
        {
            continue;
        }
        if ((max == windowBounds.second) || (it->meanSinr > max->meanSinr))
        {
            max = it;
        }
    }
    return max;
}
 
bool
SatPhyRxCarrierPerWindow::PacketCanBeDetected(
    const SatPhyRxCarrierPerWindow::essaPacketRxParams_s& packet)
{
    NS_LOG_FUNCTION(this);
 
    return (packet.preambleMeanSinr >= m_detectionThreshold);
}
 
void
SatPhyRxCarrierPerWindow::AddEssaPacket(
    SatPhyRxCarrierPerWindow::essaPacketRxParams_s essaPacketParams)
{
    NS_LOG_FUNCTION(this);
 
    NS_LOG_INFO("SatPhyRxCarrierPerWindow::AddEssaPacket - Add packet "
                << essaPacketParams.rxParams->m_txInfo.crdsaUniquePacketId << " from "
                << essaPacketParams.sourceAddress
                << " Arrival Time: " << essaPacketParams.arrivalTime.GetSeconds()
                << " Duration: " << essaPacketParams.duration.GetSeconds());
 
    m_essaPacketContainer.push_back(essaPacketParams);
}
 
void
SatPhyRxCarrierPerWindow::MeasureRandomAccessLoad()
{
    NS_LOG_FUNCTION(this);
 
    double normalizedOfferedLoad = CalculateNormalizedOfferedRandomAccessLoad();
 
    SaveMeasuredRandomAccessLoad(normalizedOfferedLoad);
 
    double averageNormalizedOfferedLoad = CalculateAverageNormalizedOfferedRandomAccessLoad();
 
    NS_LOG_INFO("Average normalized offered load: " << averageNormalizedOfferedLoad);
 
    m_windowLoadTrace(normalizedOfferedLoad);
 
    if (GetChannelType() == SatEnums::RETURN_FEEDER_CH)
    {
        m_avgNormalizedOfferedLoadCallback(GetSatId(),
                                           GetBeamId(),
                                           GetCarrierId(),
                                           GetRandomAccessAllocationChannelId(),
                                           averageNormalizedOfferedLoad);
    }
}
 
double
SatPhyRxCarrierPerWindow::CalculateNormalizedOfferedRandomAccessLoad()
{
    NS_LOG_FUNCTION(this);
 
    double normalizedOfferedLoad = m_payloadBytesInWindow * SatConstVariables::BITS_PER_BYTE /
                                   m_windowDuration.GetSeconds() / m_rxBandwidthHz;
 
    NS_LOG_INFO("Payload Bytes in Window: "
                << m_payloadBytesInWindow << ", Window duration in seconds: "
                << m_windowDuration.GetSeconds() << ", Bandwidth in Hz: " << m_rxBandwidthHz
                << ", normalized offered load (bps/Hz): " << normalizedOfferedLoad);
 
    return normalizedOfferedLoad;
}
 
} // namespace ns3