satellite-handover-test.cc

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2014 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: Bastien Tauran <bastien.tauran@viveris.fr>
 */

 
#include "ns3/cbr-application.h"
#include "ns3/cbr-helper.h"
#include "ns3/config.h"
#include "ns3/log.h"
#include "ns3/packet-sink-helper.h"
#include "ns3/packet-sink.h"
#include "ns3/satellite-env-variables.h"
#include "ns3/satellite-gw-mac.h"
#include "ns3/satellite-helper.h"
#include "ns3/satellite-id-mapper.h"
#include "ns3/satellite-isl-arbiter-unicast.h"
#include "ns3/satellite-isl-arbiter.h"
#include "ns3/satellite-orbiter-feeder-phy.h"
#include "ns3/satellite-orbiter-net-device.h"
#include "ns3/satellite-orbiter-user-phy.h"
#include "ns3/satellite-phy-rx-carrier.h"
#include "ns3/satellite-topology.h"
#include "ns3/satellite-ut-mac-state.h"
#include "ns3/simulation-helper.h"
#include "ns3/simulator.h"
#include "ns3/singleton.h"
#include "ns3/string.h"
#include "ns3/test.h"
 
#include <fstream>
#include <iostream>
 
using namespace ns3;

class SatHandoverTest1 : public TestCase
{
  public:
    SatHandoverTest1();
    virtual ~SatHandoverTest1();
 
  private:
    virtual void DoRun(void);
 
    std::vector<std::string> Split(std::string s, char del);
    void TestFileValue(std::string path, uint32_t time, double expectedValue);
};
 
// Add some help text to this case to describe what it is intended to test
SatHandoverTest1::SatHandoverTest1()
    : TestCase("This case tests that a application throughputs PerEntity are correct.")
{
}
 
// This destructor does nothing but we include it as a reminder that
// the test case should clean up after itself
SatHandoverTest1::~SatHandoverTest1()
{
}
 
std::vector<std::string>
SatHandoverTest1::Split(std::string s, char del)
{
    std::stringstream ss(s);
    std::string word;
    std::vector<std::string> tokens;
    while (!ss.eof())
    {
        std::getline(ss, word, del);
        tokens.push_back(word);
    }
    return tokens;
}
 
void
SatHandoverTest1::TestFileValue(std::string path, uint32_t time, double expectedValue)
{
    std::string line;
    std::ifstream myfile(path);
    std::string delimiter = " ";
    std::string token;
    bool valueFound;
 
    if (myfile.is_open())
    {
        valueFound = false;
        while (std::getline(myfile, line))
        {
            std::vector<std::string> tokens = Split(line, ' ');
            if (tokens.size() == 2)
            {
                if ((uint32_t)std::stoi(tokens[0]) == time)
                {
                    NS_TEST_ASSERT_MSG_EQ_TOL(std::stof(tokens[1]),
                                              expectedValue,
                                              expectedValue / 10,
                                              "Incorrect throughput for statistic " << path);
                    valueFound = true;
                    break;
                }
            }
        }
        myfile.close();
        if (!valueFound)
        {
            NS_TEST_ASSERT_MSG_EQ(0, 1, "Cannot find time " << time << " for trace file " << path);
        }
    }
    else
    {
        NS_TEST_ASSERT_MSG_EQ(0, 1, "Cannot read trace file " << path);
    }
}
 
//
// SatHandoverTest1 TestCase implementation
//
void
SatHandoverTest1::DoRun(void)
{
    Config::Reset();
    Singleton<SatIdMapper>::Get()->Reset();
 
    // Set simulation output details
    SatEnvVariables::GetInstance()->DoInitialize();
    SatEnvVariables::GetInstance()->SetOutputVariables("test-sat-handover", "test1", true);

    Config::SetDefault("ns3::SatConf::ForwardLinkRegenerationMode",
                       EnumValue(SatEnums::REGENERATION_NETWORK));
    Config::SetDefault("ns3::SatConf::ReturnLinkRegenerationMode",
                       EnumValue(SatEnums::REGENERATION_NETWORK));
 
    Config::SetDefault("ns3::SatOrbiterFeederPhy::QueueSize", UintegerValue(100000));
 
    Config::SetDefault("ns3::SatHelper::HandoversEnabled", BooleanValue(true));
    Config::SetDefault("ns3::SatHandoverModule::NumberClosestSats", UintegerValue(2));
 
    Config::SetDefault("ns3::SatGwMac::DisableSchedulingIfNoDeviceConnected", BooleanValue(true));
    Config::SetDefault("ns3::SatOrbiterMac::DisableSchedulingIfNoDeviceConnected",
                       BooleanValue(true));

    Config::SetDefault("ns3::SatEnvVariables::EnableSimulationOutputOverwrite", BooleanValue(true));

    Config::SetDefault("ns3::SatHelper::PacketTraceEnabled", BooleanValue(true));
    Ptr<SimulationHelper> simulationHelper =
        CreateObject<SimulationHelper>("test-sat-handover/test1");
    Ptr<SimulationHelperConf> simulationConf = CreateObject<SimulationHelperConf>();
    simulationHelper->SetGwUserCount(1);
    simulationHelper->SetUserCountPerUt(1);
    simulationHelper->SetBeamSet({0,  20, 21, 22, 32, 33, 34, 35, 36, 37, 44, 45, 46,
                                  47, 53, 54, 55, 56, 59, 60, 61, 66, 67, 68, 71, 72});
    simulationHelper->SetUserCountPerMobileUt(simulationConf->m_utMobileUserCount);
 
    simulationHelper->LoadScenario("constellation-eutelsat-geo-2-sats-handovers");
 
    std::string mobileUtFolder = SatEnvVariables::GetInstance()->LocateDataDirectory() +
                                 "/additional-input/utpositions/mobiles/scenario6";
    simulationHelper->CreateSatScenario(SatHelper::NONE, mobileUtFolder);
 
    simulationHelper->GetTrafficHelper()->AddCbrTraffic(
        SatTrafficHelper::FWD_LINK,
        SatTrafficHelper::UDP,
        MilliSeconds(100),
        512,
        NodeContainer(Singleton<SatTopology>::Get()->GetGwUserNode(0)),
        Singleton<SatTopology>::Get()->GetUtUserNodes(),
        Seconds(1),
        Seconds(25),
        Seconds(0));
 
    Ptr<SatStatsHelperContainer> s = simulationHelper->GetStatisticsContainer();
 
    s->AddPerSatFwdAppThroughput(SatStatsHelper::OUTPUT_SCATTER_FILE);
    s->AddPerBeamFwdAppThroughput(SatStatsHelper::OUTPUT_SCATTER_FILE);
    s->AddPerUtFwdAppThroughput(SatStatsHelper::OUTPUT_SCATTER_FILE);
    s->AddPerGwFwdAppThroughput(SatStatsHelper::OUTPUT_SCATTER_FILE);
 
    s->AddPerSatFwdUserMacThroughput(SatStatsHelper::OUTPUT_SCATTER_FILE);
    s->AddPerBeamFwdUserMacThroughput(SatStatsHelper::OUTPUT_SCATTER_FILE);
    s->AddPerUtFwdUserMacThroughput(SatStatsHelper::OUTPUT_SCATTER_FILE);
    s->AddPerGwFwdUserMacThroughput(SatStatsHelper::OUTPUT_SCATTER_FILE);
 
    simulationHelper->SetSimulationTime(Seconds(30));
    simulationHelper->RunSimulation();
 
    Simulator::Destroy();
 
    // Per satellite APP throughput
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-sat-fwd-app-throughput-scatter-1.txt",
                  8,
                  122.88);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-sat-fwd-app-throughput-scatter-2.txt",
                  8,
                  40.96);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-sat-fwd-app-throughput-scatter-1.txt",
                  18,
                  81.92);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-sat-fwd-app-throughput-scatter-2.txt",
                  18,
                  81.92);
 
    // Per satellite MAC throughput
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-sat-fwd-user-mac-throughput-scatter-1.txt",
                  8,
                  122.88);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-sat-fwd-user-mac-throughput-scatter-2.txt",
                  8,
                  40.96);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-sat-fwd-user-mac-throughput-scatter-1.txt",
                  18,
                  81.92);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-sat-fwd-user-mac-throughput-scatter-2.txt",
                  18,
                  81.92);
 
    // Per beam APP throughput
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-beam-fwd-app-throughput-scatter-1-35.txt",
                  8,
                  40.96);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-beam-fwd-app-throughput-scatter-2-20.txt",
                  8,
                  0);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-beam-fwd-app-throughput-scatter-1-35.txt",
                  18,
                  0);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-beam-fwd-app-throughput-scatter-2-20.txt",
                  18,
                  40.96);
 
    // Per beam MAC throughput
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-beam-fwd-user-mac-throughput-scatter-1-35.txt",
                  8,
                  40.96);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-beam-fwd-user-mac-throughput-scatter-2-20.txt",
                  8,
                  0);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-beam-fwd-user-mac-throughput-scatter-1-35.txt",
                  18,
                  0);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-beam-fwd-user-mac-throughput-scatter-2-20.txt",
                  18,
                  40.96);
 
    // Per GW APP throughput
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-gw-fwd-app-throughput-scatter-1.txt",
                  8,
                  81.92);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-gw-fwd-app-throughput-scatter-2.txt",
                  8,
                  81.92);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-gw-fwd-app-throughput-scatter-1.txt",
                  18,
                  40.96);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-gw-fwd-app-throughput-scatter-2.txt",
                  18,
                  122.88);
 
    // Per GW MAC throughput
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-gw-fwd-user-mac-throughput-scatter-1.txt",
                  8,
                  81.92);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-gw-fwd-user-mac-throughput-scatter-2.txt",
                  8,
                  81.92);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-gw-fwd-user-mac-throughput-scatter-1.txt",
                  18,
                  40.96);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-gw-fwd-user-mac-throughput-scatter-2.txt",
                  18,
                  122.88);
 
    // Per UT APP throughput
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-ut-fwd-app-throughput-scatter-1.txt",
                  8,
                  40.96);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-ut-fwd-app-throughput-scatter-2.txt",
                  8,
                  40.96);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-ut-fwd-app-throughput-scatter-3.txt",
                  8,
                  40.96);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-ut-fwd-app-throughput-scatter-4.txt",
                  8,
                  40.96);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-ut-fwd-app-throughput-scatter-1.txt",
                  18,
                  40.96);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-ut-fwd-app-throughput-scatter-2.txt",
                  18,
                  40.96);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-ut-fwd-app-throughput-scatter-3.txt",
                  18,
                  40.96);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-ut-fwd-app-throughput-scatter-4.txt",
                  18,
                  40.96);
 
    // Per UT MAC throughput
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-ut-fwd-user-mac-throughput-scatter-1.txt",
                  8,
                  40.96);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-ut-fwd-user-mac-throughput-scatter-2.txt",
                  8,
                  40.96);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-ut-fwd-user-mac-throughput-scatter-3.txt",
                  8,
                  40.96);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-ut-fwd-user-mac-throughput-scatter-4.txt",
                  8,
                  40.96);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-ut-fwd-user-mac-throughput-scatter-1.txt",
                  18,
                  40.96);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-ut-fwd-user-mac-throughput-scatter-2.txt",
                  18,
                  40.96);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-ut-fwd-user-mac-throughput-scatter-3.txt",
                  18,
                  40.96);
    TestFileValue("contrib/satellite/data/sims/test-sat-handover/test1/"
                  "stat-per-ut-fwd-user-mac-throughput-scatter-4.txt",
                  18,
                  40.96);
}

class SatHandoverTest2 : public TestCase
{
  public:
    SatHandoverTest2();
    virtual ~SatHandoverTest2();
 
  private:
    bool HasSinkInstalled(Ptr<Node> node, uint16_t port);
    virtual void DoRun(void);
};
 
// Add some help text to this case to describe what it is intended to test
SatHandoverTest2::SatHandoverTest2()
    : TestCase("This case tests that communication remains after GW handover.")
{
}
 
// This destructor does nothing but we include it as a reminder that
// the test case should clean up after itself
SatHandoverTest2::~SatHandoverTest2()
{
}
 
bool
SatHandoverTest2::HasSinkInstalled(Ptr<Node> node, uint16_t port)
{
    for (uint32_t i = 0; i < node->GetNApplications(); i++)
    {
        auto sink = DynamicCast<PacketSink>(node->GetApplication(i));
        if (sink != nullptr)
        {
            AddressValue av;
            sink->GetAttribute("Local", av);
            if (InetSocketAddress::ConvertFrom(av.Get()).GetPort() == port)
            {
                return true;
            }
        }
    }
    return false;
}
 
//
// SatHandoverTest2 TestCase implementation
//
void
SatHandoverTest2::DoRun(void)
{
    Config::Reset();
    Singleton<SatIdMapper>::Get()->Reset();
 
    // Set simulation output details
    SatEnvVariables::GetInstance()->DoInitialize();
    SatEnvVariables::GetInstance()->SetOutputVariables("test-sat-handover", "test2", true);

    Config::SetDefault("ns3::SatConf::ForwardLinkRegenerationMode",
                       EnumValue(SatEnums::REGENERATION_NETWORK));
    Config::SetDefault("ns3::SatConf::ReturnLinkRegenerationMode",
                       EnumValue(SatEnums::REGENERATION_NETWORK));
 
    Config::SetDefault("ns3::SatOrbiterFeederPhy::QueueSize", UintegerValue(100000));
 
    Config::SetDefault("ns3::SatHelper::HandoversEnabled", BooleanValue(true));
    Config::SetDefault("ns3::SatHandoverModule::NumberClosestSats", UintegerValue(2));
 
    Config::SetDefault("ns3::SatGwMac::DisableSchedulingIfNoDeviceConnected", BooleanValue(true));
    Config::SetDefault("ns3::SatOrbiterMac::DisableSchedulingIfNoDeviceConnected",
                       BooleanValue(true));

    Config::SetDefault("ns3::SatEnvVariables::EnableSimulationOutputOverwrite", BooleanValue(true));

    Config::SetDefault("ns3::SatHelper::PacketTraceEnabled", BooleanValue(true));
    Ptr<SimulationHelper> simulationHelper =
        CreateObject<SimulationHelper>("test-sat-handover/test2");
    Ptr<SimulationHelperConf> simulationConf = CreateObject<SimulationHelperConf>();
    simulationHelper->SetSimulationTime(Seconds(50));
    simulationHelper->SetGwUserCount(1);
    simulationHelper->SetUserCountPerUt(1);
    std::set<uint32_t> beamSetAll = {1,  2,  3,  4,  5,  6,  7,  8,  9,  10, 11, 12, 13, 14, 15,
                                     16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30,
                                     31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45,
                                     46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60,
                                     61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72};
    simulationHelper->SetBeamSet(beamSetAll);
    simulationHelper->SetUserCountPerMobileUt(simulationConf->m_utMobileUserCount);
 
    simulationHelper->LoadScenario("constellation-leo-2-satellites");
 
    Ptr<SatHelper> helper = simulationHelper->CreateSatScenario(SatHelper::NONE);
 
    NodeContainer utUsers = Singleton<SatTopology>::Get()->GetUtUserNodes();
    NodeContainer gwUsers = Singleton<SatTopology>::Get()->GetGwUserNodes();
 
    Config::SetDefault("ns3::CbrApplication::Interval", StringValue("100ms"));
    Config::SetDefault("ns3::CbrApplication::PacketSize", UintegerValue(512));
 
    uint16_t port = 9;
    PacketSinkHelper sinkHelper("ns3::UdpSocketFactory", Address());
    CbrHelper cbrHelper("ns3::UdpSocketFactory", Address());
    ApplicationContainer sinkContainer;
    ApplicationContainer cbrContainer;
    // create CBR applications on UT users
    for (uint32_t i = 0; i < utUsers.GetN(); i++)
    {
        InetSocketAddress utUserAddr =
            InetSocketAddress(helper->GetUserAddress(utUsers.Get(i)), port);
        if (!HasSinkInstalled(utUsers.Get(i), port))
        {
            sinkHelper.SetAttribute("Local", AddressValue(Address(utUserAddr)));
            sinkContainer.Add(sinkHelper.Install(utUsers.Get(i)));
        }
 
        cbrHelper.SetAttribute("Remote", AddressValue(Address(utUserAddr)));
        auto app = cbrHelper.Install(gwUsers.Get(0)).Get(0);
        app->SetStartTime(Seconds(1.0));
        cbrContainer.Add(app);
    }
    sinkContainer.Start(Seconds(1.0));
    sinkContainer.Stop(Seconds(45.0));
 
    simulationHelper->RunSimulation();
 
    Simulator::Destroy();
 
    for (uint32_t i = 0; i < 5; i++)
    {
        Ptr<PacketSink> utReceiver = DynamicCast<PacketSink>(sinkContainer.Get(i));
        Ptr<CbrApplication> gwSender = DynamicCast<CbrApplication>(cbrContainer.Get(i));
 
        NS_TEST_ASSERT_MSG_NE(gwSender->GetSent(), 0, "Nothing sent by GW app " << i << "!");
 
        NS_TEST_ASSERT_MSG_EQ_TOL(utReceiver->GetTotalRx(),
                                  gwSender->GetSent(),
                                  gwSender->GetSent() / 5,
                                  "Too many packets were lost to UT!");
    }
}
 
// The TestSuite class names the TestSuite as sat-handover-test, identifies what type of
// TestSuite (Type::SYSTEM), and enables the TestCases to be run. Typically, only the constructor
// for this class must be defined
//
class SatHandoverTestSuite : public TestSuite
{
  public:
    SatHandoverTestSuite();
};
 
SatHandoverTestSuite::SatHandoverTestSuite()
    : TestSuite("sat-handover-test", Type::SYSTEM)
{
    AddTestCase(new SatHandoverTest1,
                TestCase::Duration::QUICK); // This case tests that a application throughputs
                                            // PerEntity are correct.
    AddTestCase(
        new SatHandoverTest2,
        TestCase::Duration::QUICK); // This case tests that communication remains after GW handover.
}
 
// Allocate an instance of this TestSuite
static SatHandoverTestSuite satHandoverTestSuite;