tgax-virtual-desktop.cc

Go to the documentation of this file.

/*
 * Copyright (c) 2024 DERONNE SOFTWARE ENGINEERING
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 * Author: Sébastien Deronne <sebastien.deronne@gmail.com>
 */
 
#include "tgax-virtual-desktop.h"
 
#include "ns3/attribute-container.h"
#include "ns3/double.h"
#include "ns3/enum.h"
#include "ns3/inet-socket-address.h"
#include "ns3/inet6-socket-address.h"
#include "ns3/log.h"
#include "ns3/node.h"
#include "ns3/nstime.h"
#include "ns3/packet-socket-address.h"
#include "ns3/packet.h"
#include "ns3/pair.h"
#include "ns3/pointer.h"
#include "ns3/random-variable-stream.h"
#include "ns3/simulator.h"
#include "ns3/socket-factory.h"
#include "ns3/socket.h"
#include "ns3/string.h"
 
#include <cmath>
 
namespace ns3
{
 
NS_LOG_COMPONENT_DEFINE("TgaxVirtualDesktop");
 
NS_OBJECT_ENSURE_REGISTERED(TgaxVirtualDesktop);
 
TypeId
TgaxVirtualDesktop::GetTypeId()
{
    static TypeId tid =
        TypeId("ns3::TgaxVirtualDesktop")
            .SetParent<SourceApplication>()
            .SetGroupName("Applications")
            .AddConstructor<TgaxVirtualDesktop>()
            .AddAttribute("ModelPresets",
                          "The model presets to use (Custom for custom settings)",
                          TypeId::ATTR_GET |
                              TypeId::ATTR_CONSTRUCT, // prevent setting after construction
                          EnumValue(TgaxVirtualDesktop::ModelPresets::CUSTOM),
                          MakeEnumAccessor<ModelPresets>(&TgaxVirtualDesktop::m_modelPresets),
                          MakeEnumChecker(TgaxVirtualDesktop::ModelPresets::CUSTOM,
                                          "Custom",
                                          TgaxVirtualDesktop::ModelPresets::DOWNLINK,
                                          "Downlink",
                                          TgaxVirtualDesktop::ModelPresets::UPLINK,
                                          "Uplink"))
            .AddAttribute(
                "Protocol",
                "The type of protocol to use. This should be a subclass of ns3::SocketFactory",
                TypeIdValue(TypeId::LookupByName("ns3::TcpSocketFactory")),
                MakeTypeIdAccessor(&TgaxVirtualDesktop::m_protocolTid),
                MakeTypeIdChecker())
            .AddAttribute(
                "CustomInitialPacketArrival",
                "A uniform random variable to generate the initial packet arrival in nanoseconds.",
                StringValue("ns3::UniformRandomVariable[Min=0|Max=20000000]"),
                MakePointerAccessor(&TgaxVirtualDesktop::m_initialArrivalUniform),
                MakePointerChecker<UniformRandomVariable>())
            .AddAttribute("CustomInterPacketArrivals",
                          "An exponential random variable to generate the inter packet arrivals in "
                          "nanoseconds.",
                          StringValue("ns3::ExponentialRandomVariable[Mean=60226900]"),
                          MakePointerAccessor(&TgaxVirtualDesktop::m_interArrivalExponential),
                          MakePointerChecker<ExponentialRandomVariable>())
            .AddAttribute(
                "CustomParametersPacketSize",
                "The mean value and standard deviation for each mode of the multimodal normal "
                "distribution used to calculate packet sizes.",
                StringValue("41.0 3.2;1478.3 11.6"),
                MakeAttributeContainerAccessor<PairValue<DoubleValue, DoubleValue>, ';'>(
                    &TgaxVirtualDesktop::SetParametersPacketSize),
                MakeAttributeContainerChecker<PairValue<DoubleValue, DoubleValue>, ';'>(
                    MakePairChecker<DoubleValue, DoubleValue>(MakeDoubleChecker<double>(),
                                                              MakeDoubleChecker<double>())));
    return tid;
}
 
TgaxVirtualDesktop::TgaxVirtualDesktop()
{
    NS_LOG_FUNCTION(this);
}
 
TgaxVirtualDesktop::~TgaxVirtualDesktop()
{
    NS_LOG_FUNCTION(this);
}
 
int64_t
TgaxVirtualDesktop::AssignStreams(int64_t stream)
{
    NS_LOG_FUNCTION(this << stream);
    auto currentStream = stream;
    m_initialArrivalUniform->SetStream(currentStream++);
    m_interArrivalExponential->SetStream(currentStream++);
    if (m_pktSizeDistributions.size() > 1)
    {
        m_dlModeSelection->SetStream(currentStream++);
    }
    for (auto& pktSizeDistribution : m_pktSizeDistributions)
    {
        pktSizeDistribution->SetStream(currentStream++);
    }
    return (currentStream - stream);
}
 
void
TgaxVirtualDesktop::SetParametersPacketSize(const std::vector<std::pair<double, double>>& params)
{
    m_pktSizeDistributions.clear();
    NS_LOG_FUNCTION(this << params.size());
    for (const auto& [mean, std] : params)
    {
        auto normal = CreateObject<NormalRandomVariable>();
        normal->SetAttribute("Mean", DoubleValue(mean));
        normal->SetAttribute("Variance", DoubleValue(std::pow(std, 2)));
        m_pktSizeDistributions.push_back(normal);
    }
    if ((m_pktSizeDistributions.size() > 1) && !m_dlModeSelection)
    {
        m_dlModeSelection =
            CreateObjectWithAttributes<BernoulliRandomVariable>("Probability",
                                                                DoubleValue(22.4 / 76.1));
    }
}
 
void
TgaxVirtualDesktop::DoInitialize()
{
    NS_LOG_FUNCTION(this);
    SourceApplication::DoInitialize();
 
    if (m_modelPresets != ModelPresets::CUSTOM)
    {
        std::vector<std::pair<double, double>> params;
        if (m_modelPresets == ModelPresets::DOWNLINK)
        {
            // Downlink model presets
            params = {{41.0, 3.2}, {1478.3, 11.6}};
            m_initialArrivalUniform->SetAttribute("Min", DoubleValue(0.0));
            m_initialArrivalUniform->SetAttribute("Max", DoubleValue(20000000.0));
            m_interArrivalExponential->SetAttribute("Mean", DoubleValue(60226900.0));
        }
        else if (m_modelPresets == ModelPresets::UPLINK)
        {
            // Uplink model presets
            params = {{50.598, 5.0753}};
            m_initialArrivalUniform->SetAttribute("Min", DoubleValue(0.0));
            m_initialArrivalUniform->SetAttribute("Max", DoubleValue(20000000.0));
            m_interArrivalExponential->SetAttribute("Mean", DoubleValue(48287000.0));
        }
        SetParametersPacketSize(params);
    }
}
 
void
TgaxVirtualDesktop::DoStartApplication()
{
    NS_LOG_FUNCTION(this);
 
    m_socket->SetDataSentCallback(MakeCallback(&TgaxVirtualDesktop::TxDone, this));
    m_socket->SetSendCallback(MakeCallback(&TgaxVirtualDesktop::TxAvailable, this));
    m_socket->SetAllowBroadcast(true);
    m_socket->ShutdownRecv();
 
    if (m_connected)
    {
        ScheduleNext();
    }
}
 
void
TgaxVirtualDesktop::CancelEvents()
{
    NS_LOG_FUNCTION(this);
    m_txEvent.Cancel();
    if (m_unsentPacket)
    {
        NS_LOG_DEBUG("Discarding cached packet upon CancelEvents ()");
    }
    m_unsentPacket = nullptr;
    m_initialPacket = true;
}
 
Time
TgaxVirtualDesktop::GetInterArrival() const
{
    if (m_unsentPacket)
    {
        return Time();
    }
    if (m_initialPacket)
    {
        return NanoSeconds(m_initialArrivalUniform->GetValue());
    }
    return NanoSeconds(m_interArrivalExponential->GetValue());
}
 
uint32_t
TgaxVirtualDesktop::GetPacketSize() const
{
    const auto mode = (m_pktSizeDistributions.size() > 1) ? m_dlModeSelection->GetValue() : 0;
    return m_pktSizeDistributions.at(mode)->GetValue();
}
 
void
TgaxVirtualDesktop::ScheduleNext()
{
    NS_LOG_FUNCTION(this);
    NS_ASSERT(!m_txEvent.IsPending());
    m_txEvent = Simulator::Schedule(GetInterArrival(), &TgaxVirtualDesktop::SendPacket, this);
}
 
void
TgaxVirtualDesktop::SendPacket()
{
    NS_LOG_FUNCTION(this);
 
    NS_ASSERT(m_txEvent.IsExpired());
 
    Ptr<Packet> packet;
    if (m_unsentPacket)
    {
        packet = m_unsentPacket;
    }
    else
    {
        packet = Create<Packet>(GetPacketSize());
    }
 
    unsigned int actualSize = m_socket->Send(packet);
    if (actualSize == packet->GetSize())
    {
        m_txTrace(packet);
        m_unsentPacket = nullptr;
        Address localAddress;
        m_socket->GetSockName(localAddress);
        if (InetSocketAddress::IsMatchingType(m_peer))
        {
            NS_LOG_INFO("At time " << Simulator::Now().As(Time::S) << " VDI traffic source sent "
                                   << (m_initialPacket ? "initial packet of " : "packet of ")
                                   << packet->GetSize() << " bytes to "
                                   << InetSocketAddress::ConvertFrom(m_peer).GetIpv4() << " port "
                                   << InetSocketAddress::ConvertFrom(m_peer).GetPort());
        }
        else if (Inet6SocketAddress::IsMatchingType(m_peer))
        {
            NS_LOG_INFO("At time " << Simulator::Now().As(Time::S) << " VDI traffic source sent "
                                   << (m_initialPacket ? "initial packet of " : "packet of ")
                                   << packet->GetSize() << " bytes to "
                                   << Inet6SocketAddress::ConvertFrom(m_peer).GetIpv6() << " port "
                                   << Inet6SocketAddress::ConvertFrom(m_peer).GetPort());
        }
    }
    else
    {
        NS_LOG_DEBUG("Unable to send VDI packet; actual " << actualSize << " size "
                                                          << packet->GetSize()
                                                          << "; caching for later attempt");
        m_unsentPacket = packet;
    }
 
    if (m_initialPacket)
    {
        m_initialPacket = false;
    }
 
    ScheduleNext();
}
 
void
TgaxVirtualDesktop::DoConnectionSucceeded(Ptr<Socket> socket)
{
    NS_LOG_FUNCTION(this << socket);
    ScheduleNext();
}
 
void
TgaxVirtualDesktop::TxDone(Ptr<Socket> socket, uint32_t size)
{
    NS_LOG_FUNCTION(this << socket << size);
    if (m_unsentPacket)
    {
        ScheduleNext();
    }
}
 
void
TgaxVirtualDesktop::TxAvailable(Ptr<Socket> socket, uint32_t available)
{
    NS_LOG_FUNCTION(this << socket << available);
    if (m_unsentPacket)
    {
        ScheduleNext();
    }
}
 
} // Namespace ns3