spectrum-wifi-phy-test.cc

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2015 University of Washington
 *
 * 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
 */

#include "ns3/test.h"
#include "ns3/constant-position-mobility-model.h"
#include "ns3/spectrum-wifi-helper.h"
#include "ns3/wifi-spectrum-value-helper.h"
#include "ns3/multi-model-spectrum-channel.h"
#include "ns3/spectrum-wifi-phy.h"
#include "ns3/nist-error-rate-model.h"
#include "ns3/wifi-mac-header.h"
#include "ns3/wifi-spectrum-signal-parameters.h"
#include "ns3/wifi-phy-listener.h"
#include "ns3/log.h"
#include "ns3/wifi-net-device.h"
#include "ns3/wifi-psdu.h"
#include "ns3/ofdm-ppdu.h"
#include "ns3/wifi-utils.h"
#include "ns3/he-phy.h" //includes OFDM PHY

using namespace ns3;

NS_LOG_COMPONENT_DEFINE ("SpectrumWifiPhyBasicTest");

static const uint8_t CHANNEL_NUMBER = 36;
static const uint32_t FREQUENCY = 5180; // MHz
static const uint16_t CHANNEL_WIDTH = 20; // MHz
static const uint16_t GUARD_WIDTH = CHANNEL_WIDTH; // MHz (expanded to channel width to model spectrum mask)

class ExtSpectrumWifiPhy : public SpectrumWifiPhy
{
public:
  using SpectrumWifiPhy::SpectrumWifiPhy;
  using SpectrumWifiPhy::GetBand;
};

class SpectrumWifiPhyBasicTest : public TestCase
{
public:
  SpectrumWifiPhyBasicTest ();
  SpectrumWifiPhyBasicTest (std::string name);
  virtual ~SpectrumWifiPhyBasicTest ();

protected:
  void DoSetup (void) override;
  void DoTeardown (void) override;
  Ptr<SpectrumWifiPhy> m_phy; 

  Ptr<SpectrumSignalParameters> MakeSignal (double txPowerWatts);
  void SendSignal (double txPowerWatts);
  void SpectrumWifiPhyRxSuccess (Ptr<WifiPsdu> psdu, RxSignalInfo rxSignalInfo,
                                 WifiTxVector txVector, std::vector<bool> statusPerMpdu);
  void SpectrumWifiPhyRxFailure (Ptr<WifiPsdu> psdu);
  uint32_t m_count; 

private:
  void DoRun (void) override;

  uint64_t m_uid; 
};

SpectrumWifiPhyBasicTest::SpectrumWifiPhyBasicTest ()
  : SpectrumWifiPhyBasicTest ("SpectrumWifiPhy test case receives one packet")
{
}

SpectrumWifiPhyBasicTest::SpectrumWifiPhyBasicTest (std::string name)
  : TestCase (name),
    m_count (0),
    m_uid (0)
{
}

// Make a Wi-Fi signal to inject directly to the StartRx() method
Ptr<SpectrumSignalParameters>
SpectrumWifiPhyBasicTest::MakeSignal (double txPowerWatts)
{
  WifiTxVector txVector = WifiTxVector (OfdmPhy::GetOfdmRate6Mbps (), 0, WIFI_PREAMBLE_LONG, 800, 1, 1, 0, 20, false);

  Ptr<Packet> pkt = Create<Packet> (1000);
  WifiMacHeader hdr;

  hdr.SetType (WIFI_MAC_QOSDATA);
  hdr.SetQosTid (0);

  Ptr<WifiPsdu> psdu = Create<WifiPsdu> (pkt, hdr);
  Time txDuration = m_phy->CalculateTxDuration (psdu->GetSize (), txVector, m_phy->GetPhyBand ());

  Ptr<WifiPpdu> ppdu = Create<OfdmPpdu> (psdu, txVector, WIFI_PHY_BAND_5GHZ, m_uid++);

  Ptr<SpectrumValue> txPowerSpectrum = WifiSpectrumValueHelper::CreateOfdmTxPowerSpectralDensity (FREQUENCY, CHANNEL_WIDTH, txPowerWatts, GUARD_WIDTH);
  Ptr<WifiSpectrumSignalParameters> txParams = Create<WifiSpectrumSignalParameters> ();
  txParams->psd = txPowerSpectrum;
  txParams->txPhy = 0;
  txParams->duration = txDuration;
  txParams->ppdu = ppdu;

  return txParams;
}

// Make a Wi-Fi signal to inject directly to the StartRx() method
void
SpectrumWifiPhyBasicTest::SendSignal (double txPowerWatts)
{
  m_phy->StartRx (MakeSignal (txPowerWatts));
}

void
SpectrumWifiPhyBasicTest::SpectrumWifiPhyRxSuccess (Ptr<WifiPsdu> psdu, RxSignalInfo rxSignalInfo,
                                                    WifiTxVector txVector, std::vector<bool> statusPerMpdu)
{
  NS_LOG_FUNCTION (this << *psdu << rxSignalInfo << txVector);
  m_count++;
}

void
SpectrumWifiPhyBasicTest::SpectrumWifiPhyRxFailure (Ptr<WifiPsdu> psdu)
{
  NS_LOG_FUNCTION (this << *psdu);
  m_count++;
}

SpectrumWifiPhyBasicTest::~SpectrumWifiPhyBasicTest ()
{
}

// Create necessary objects, and inject signals.  Test that the expected
// number of packet receptions occur.
void
SpectrumWifiPhyBasicTest::DoSetup (void)
{
  m_phy = CreateObject<SpectrumWifiPhy> ();
  m_phy->ConfigureStandardAndBand (WIFI_PHY_STANDARD_80211n, WIFI_PHY_BAND_5GHZ);
  Ptr<ErrorRateModel> error = CreateObject<NistErrorRateModel> ();
  m_phy->SetErrorRateModel (error);
  m_phy->SetChannelNumber (CHANNEL_NUMBER);
  m_phy->SetFrequency (FREQUENCY);
  m_phy->SetReceiveOkCallback (MakeCallback (&SpectrumWifiPhyBasicTest::SpectrumWifiPhyRxSuccess, this));
  m_phy->SetReceiveErrorCallback (MakeCallback (&SpectrumWifiPhyBasicTest::SpectrumWifiPhyRxFailure, this));
}

void
SpectrumWifiPhyBasicTest::DoTeardown (void)
{
  m_phy->Dispose ();
  m_phy = 0;
}

// Test that the expected number of packet receptions occur.
void
SpectrumWifiPhyBasicTest::DoRun (void)
{
  double txPowerWatts = 0.010;
  // Send packets spaced 1 second apart; all should be received
  Simulator::Schedule (Seconds (1), &SpectrumWifiPhyBasicTest::SendSignal, this, txPowerWatts);
  Simulator::Schedule (Seconds (2), &SpectrumWifiPhyBasicTest::SendSignal, this, txPowerWatts);
  Simulator::Schedule (Seconds (3), &SpectrumWifiPhyBasicTest::SendSignal, this, txPowerWatts);
  // Send packets spaced 1 microsecond second apart; none should be received (PHY header reception failure)
  Simulator::Schedule (MicroSeconds (4000000), &SpectrumWifiPhyBasicTest::SendSignal, this, txPowerWatts);
  Simulator::Schedule (MicroSeconds (4000001), &SpectrumWifiPhyBasicTest::SendSignal, this, txPowerWatts);
  Simulator::Run ();
  Simulator::Destroy ();

  NS_TEST_ASSERT_MSG_EQ (m_count, 3, "Didn't receive right number of packets");
}

class TestPhyListener : public ns3::WifiPhyListener
{
public:
  TestPhyListener (void)
    : m_notifyRxStart (0),
      m_notifyRxEndOk (0),
      m_notifyRxEndError (0),
      m_notifyMaybeCcaBusyStart (0)
  {
  }
  virtual ~TestPhyListener ()
  {
  }
  void NotifyRxStart (Time duration) override
  {
    NS_LOG_FUNCTION (this << duration);
    ++m_notifyRxStart;
  }
  void NotifyRxEndOk (void) override
  {
    NS_LOG_FUNCTION (this);
    ++m_notifyRxEndOk;
  }
  void NotifyRxEndError (void) override
  {
    NS_LOG_FUNCTION (this);
    ++m_notifyRxEndError;
  }
  void NotifyTxStart (Time duration, double txPowerDbm) override
  {
    NS_LOG_FUNCTION (this << duration << txPowerDbm);
  }
  void NotifyMaybeCcaBusyStart (Time duration) override
  {
    NS_LOG_FUNCTION (this);
    ++m_notifyMaybeCcaBusyStart;
  }
  void NotifySwitchingStart (Time duration) override
  {
  }
  void NotifySleep (void) override
  {
  }
  void NotifyOff (void) override
  {
  }
  void NotifyWakeup (void) override
  {
  }
  void NotifyOn (void) override
  {
  }
  uint32_t m_notifyRxStart; 
  uint32_t m_notifyRxEndOk; 
  uint32_t m_notifyRxEndError; 
  uint32_t m_notifyMaybeCcaBusyStart; 
};

class SpectrumWifiPhyListenerTest : public SpectrumWifiPhyBasicTest
{
public:
  SpectrumWifiPhyListenerTest ();
  virtual ~SpectrumWifiPhyListenerTest ();
private:
  void DoSetup (void) override;
  void DoRun (void) override;
  TestPhyListener* m_listener; 
};

SpectrumWifiPhyListenerTest::SpectrumWifiPhyListenerTest ()
  : SpectrumWifiPhyBasicTest ("SpectrumWifiPhy test operation of WifiPhyListener")
{
}

SpectrumWifiPhyListenerTest::~SpectrumWifiPhyListenerTest ()
{
}

void
SpectrumWifiPhyListenerTest::DoSetup (void)
{
  SpectrumWifiPhyBasicTest::DoSetup ();
  m_listener = new TestPhyListener;
  m_phy->RegisterListener (m_listener);
}

void
SpectrumWifiPhyListenerTest::DoRun (void)
{
  double txPowerWatts = 0.010;
  Simulator::Schedule (Seconds (1), &SpectrumWifiPhyListenerTest::SendSignal, this, txPowerWatts);
  Simulator::Run ();

  NS_TEST_ASSERT_MSG_EQ (m_count, 1, "Didn't receive right number of packets");
  NS_TEST_ASSERT_MSG_EQ (m_listener->m_notifyMaybeCcaBusyStart, 2, "Didn't receive NotifyMaybeCcaBusyStart (once preamble is detected + prolonged by L-SIG reception, then switched to Rx by at the beginning of data)");
  NS_TEST_ASSERT_MSG_EQ (m_listener->m_notifyRxStart, 1, "Didn't receive NotifyRxStart");
  NS_TEST_ASSERT_MSG_EQ (m_listener->m_notifyRxEndOk, 1, "Didn't receive NotifyRxEnd");

  Simulator::Destroy ();
  delete m_listener;
}

class SpectrumWifiPhyFilterTest : public TestCase
{
public:
  SpectrumWifiPhyFilterTest ();
  SpectrumWifiPhyFilterTest (std::string name);
  virtual ~SpectrumWifiPhyFilterTest ();

private:
  void DoSetup (void) override;
  void DoTeardown (void) override;
  void DoRun (void) override;

  void RunOne ();

  void SendPpdu (void);

  void RxCallback (Ptr<const Packet> p, RxPowerWattPerChannelBand rxPowersW);

  Ptr<ExtSpectrumWifiPhy> m_txPhy; 
  Ptr<ExtSpectrumWifiPhy> m_rxPhy; 

  uint16_t m_txChannelWidth; 
  uint16_t m_rxChannelWidth; 

  std::set<WifiSpectrumBand> m_ruBands; 
};

SpectrumWifiPhyFilterTest::SpectrumWifiPhyFilterTest ()
  : TestCase ("SpectrumWifiPhy test RX filters"),
    m_txChannelWidth (20),
    m_rxChannelWidth (20)
{
}

SpectrumWifiPhyFilterTest::SpectrumWifiPhyFilterTest (std::string name)
  : TestCase (name)
{
}

void
SpectrumWifiPhyFilterTest::SendPpdu (void)
{
  WifiTxVector txVector = WifiTxVector (HePhy::GetHeMcs0 (), 0, WIFI_PREAMBLE_HE_SU, 800, 1, 1, 0, m_txChannelWidth, false, false);
  Ptr<Packet> pkt = Create<Packet> (1000);
  WifiMacHeader hdr;
  hdr.SetType (WIFI_MAC_QOSDATA);
  hdr.SetQosTid (0);
  hdr.SetAddr1 (Mac48Address ("00:00:00:00:00:01"));
  hdr.SetSequenceNumber (1);
  Ptr<WifiPsdu> psdu = Create<WifiPsdu> (pkt, hdr);
  m_txPhy->Send (WifiConstPsduMap ({std::make_pair (SU_STA_ID, psdu)}), txVector);
}

SpectrumWifiPhyFilterTest::~SpectrumWifiPhyFilterTest ()
{
  m_txPhy = 0;
  m_rxPhy = 0;
}

void
SpectrumWifiPhyFilterTest::RxCallback (Ptr<const Packet> p, RxPowerWattPerChannelBand rxPowersW)
{
  for (auto const& pair : rxPowersW)
    {
      NS_LOG_INFO ("band: (" << pair.first.first << ";" << pair.first.second << ") -> powerW=" << pair.second << " (" << WToDbm (pair.second) << " dBm)");
    }

  size_t numBands = rxPowersW.size ();
  size_t expectedNumBands = std::max (1, (m_rxChannelWidth / 20));
  expectedNumBands += (m_rxChannelWidth / 40);
  expectedNumBands += (m_rxChannelWidth / 80);
  expectedNumBands += (m_rxChannelWidth / 160);
  expectedNumBands += m_ruBands.size ();

  NS_TEST_ASSERT_MSG_EQ (numBands, expectedNumBands, "Total number of bands handled by the receiver is incorrect");

  uint16_t channelWidth = std::min (m_txChannelWidth, m_rxChannelWidth);
  WifiSpectrumBand band = m_rxPhy->GetBand (channelWidth, 0);
  auto it = rxPowersW.find (band);
  NS_LOG_INFO ("powerW total band: " << it->second << " (" << WToDbm (it->second) << " dBm)");
  int totalRxPower = static_cast<int> (WToDbm (it->second) + 0.5);
  int expectedTotalRxPower;
  if (m_txChannelWidth <= m_rxChannelWidth)
    {
      //PHY sends at 16 dBm, and since there is no loss, this should be the total power at the receiver.
      expectedTotalRxPower = 16;
    }
  else
    {
      //Only a part of the transmitted power is received
      expectedTotalRxPower = 16 - static_cast<int> (RatioToDb (m_txChannelWidth / m_rxChannelWidth));
    }
  NS_TEST_ASSERT_MSG_EQ (totalRxPower, expectedTotalRxPower, "Total received power is not correct");

  if ((m_txChannelWidth <= m_rxChannelWidth) && (channelWidth >= 20))
    {
      band = m_rxPhy->GetBand (20, 0); //primary 20 MHz
      it = rxPowersW.find (band);
      NS_LOG_INFO ("powerW in primary 20 MHz channel: " << it->second << " (" << WToDbm (it->second) << " dBm)");
      int rxPowerPrimaryChannel20 = static_cast<int> (WToDbm (it->second) + 0.5);
      int expectedRxPowerPrimaryChannel20 = 16 - static_cast<int> (RatioToDb (channelWidth / 20));
      NS_TEST_ASSERT_MSG_EQ (rxPowerPrimaryChannel20, expectedRxPowerPrimaryChannel20, "Received power in the primary 20 MHz band is not correct");
    }
}

void
SpectrumWifiPhyFilterTest::DoSetup (void)
{
  //WifiHelper::EnableLogComponents ();
  //LogComponentEnable ("SpectrumWifiPhyBasicTest", LOG_LEVEL_ALL);

  Ptr<MultiModelSpectrumChannel> spectrumChannel = CreateObject<MultiModelSpectrumChannel> ();
  Ptr<FriisPropagationLossModel> lossModel = CreateObject<FriisPropagationLossModel> ();
  lossModel->SetFrequency (5.180e9);
  spectrumChannel->AddPropagationLossModel (lossModel);
  Ptr<ConstantSpeedPropagationDelayModel> delayModel = CreateObject<ConstantSpeedPropagationDelayModel> ();
  spectrumChannel->SetPropagationDelayModel (delayModel);
  
  Ptr<Node> txNode = CreateObject<Node> ();
  Ptr<WifiNetDevice> txDev = CreateObject<WifiNetDevice> ();
  m_txPhy = CreateObject<ExtSpectrumWifiPhy> ();
  m_txPhy->CreateWifiSpectrumPhyInterface (txDev);
  m_txPhy->ConfigureStandardAndBand (WIFI_PHY_STANDARD_80211ax, WIFI_PHY_BAND_5GHZ);
  Ptr<ErrorRateModel> error = CreateObject<NistErrorRateModel> ();
  m_txPhy->SetErrorRateModel (error);
  m_txPhy->SetDevice (txDev);
  m_txPhy->SetChannel (spectrumChannel);
  Ptr<ConstantPositionMobilityModel> apMobility = CreateObject<ConstantPositionMobilityModel> ();
  m_txPhy->SetMobility (apMobility);
  txDev->SetPhy (m_txPhy);
  txNode->AggregateObject (apMobility);
  txNode->AddDevice (txDev);

  Ptr<Node> rxNode = CreateObject<Node> ();
  Ptr<WifiNetDevice> rxDev = CreateObject<WifiNetDevice> ();
  m_rxPhy = CreateObject<ExtSpectrumWifiPhy> ();
  m_rxPhy->CreateWifiSpectrumPhyInterface (rxDev);
  m_rxPhy->ConfigureStandardAndBand (WIFI_PHY_STANDARD_80211ax, WIFI_PHY_BAND_5GHZ);
  m_rxPhy->SetErrorRateModel (error);
  m_rxPhy->SetChannel (spectrumChannel);
  Ptr<ConstantPositionMobilityModel> sta1Mobility = CreateObject<ConstantPositionMobilityModel> ();
  m_rxPhy->SetMobility (sta1Mobility);
  rxDev->SetPhy (m_rxPhy);
  rxNode->AggregateObject (sta1Mobility);
  rxNode->AddDevice (rxDev);
  m_rxPhy->TraceConnectWithoutContext ("PhyRxBegin", MakeCallback (&SpectrumWifiPhyFilterTest::RxCallback, this));
}

void
SpectrumWifiPhyFilterTest::DoTeardown (void)
{
  m_txPhy->Dispose ();
  m_txPhy = 0;
  m_rxPhy->Dispose ();
  m_rxPhy = 0;
}

void
SpectrumWifiPhyFilterTest::RunOne (void)
{
  uint16_t txFrequency;
  switch (m_txChannelWidth)
    {
    case 20:
    default:
      txFrequency = 5180;
      break;
    case 40:
      txFrequency = 5190;
      break;
    case 80:
      txFrequency = 5210;
      break;
    case 160:
      txFrequency = 5250;
      break;
    }
  m_txPhy->SetFrequency (txFrequency);

  uint16_t rxFrequency;
  switch (m_rxChannelWidth)
    {
    case 20:
    default:
      rxFrequency = 5180;
      break;
    case 40:
      rxFrequency = 5190;
      break;
    case 80:
      rxFrequency = 5210;
      break;
    case 160:
      rxFrequency = 5250;
      break;
    }
  m_rxPhy->SetFrequency (rxFrequency);

  m_ruBands.clear ();
  for (uint16_t bw = 160; bw >= 20; bw = bw / 2)
    {
      for (uint8_t i = 0; i < (m_rxChannelWidth / bw); ++i)
        {
          for (unsigned int type = 0; type < 7; type++)
            {
              HeRu::RuType ruType = static_cast <HeRu::RuType> (type);
              for (std::size_t index = 1; index <= HeRu::GetNRus (bw, ruType); index++)
                {
                  HeRu::SubcarrierGroup group = HeRu::GetSubcarrierGroup (bw, ruType, index);
                  HeRu::SubcarrierRange range = std::make_pair (group.front ().first, group.back ().second);
                  WifiSpectrumBand band = m_rxPhy->ConvertHeRuSubcarriers (bw, m_rxPhy->GetGuardBandwidth (m_rxChannelWidth),
                                                                           range, i);
                  m_ruBands.insert (band);
                }
            }
        }
    }

  Simulator::Schedule (Seconds (1), &SpectrumWifiPhyFilterTest::SendPpdu, this);
  
  Simulator::Run ();
}

void
SpectrumWifiPhyFilterTest::DoRun (void)
{
  m_txChannelWidth = 20;
  m_rxChannelWidth = 20;
  RunOne ();

  m_txChannelWidth = 40;
  m_rxChannelWidth = 40;
  RunOne ();

  m_txChannelWidth = 80;
  m_rxChannelWidth = 80;
  RunOne ();

  m_txChannelWidth = 160;
  m_rxChannelWidth = 160;
  RunOne ();

  m_txChannelWidth = 20;
  m_rxChannelWidth = 40;
  RunOne ();

  m_txChannelWidth = 20;
  m_rxChannelWidth = 80;
  RunOne ();

  m_txChannelWidth = 40;
  m_rxChannelWidth = 80;
  RunOne ();

  m_txChannelWidth = 20;
  m_rxChannelWidth = 160;
  RunOne ();

  m_txChannelWidth = 40;
  m_rxChannelWidth = 160;
  RunOne ();

  m_txChannelWidth = 80;
  m_rxChannelWidth = 160;
  RunOne ();

  m_txChannelWidth = 40;
  m_rxChannelWidth = 20;
  RunOne ();

  m_txChannelWidth = 80;
  m_rxChannelWidth = 20;
  RunOne ();

  m_txChannelWidth = 80;
  m_rxChannelWidth = 40;
  RunOne ();

  m_txChannelWidth = 160;
  m_rxChannelWidth = 20;
  RunOne ();

  m_txChannelWidth = 160;
  m_rxChannelWidth = 40;
  RunOne ();

  m_txChannelWidth = 160;
  m_rxChannelWidth = 80;
  RunOne ();

  Simulator::Destroy ();
}

class SpectrumWifiPhyTestSuite : public TestSuite
{
public:
  SpectrumWifiPhyTestSuite ();
};

SpectrumWifiPhyTestSuite::SpectrumWifiPhyTestSuite ()
  : TestSuite ("wifi-spectrum-wifi-phy", UNIT)
{
  AddTestCase (new SpectrumWifiPhyBasicTest, TestCase::QUICK);
  AddTestCase (new SpectrumWifiPhyListenerTest, TestCase::QUICK);
  AddTestCase (new SpectrumWifiPhyFilterTest, TestCase::QUICK);
}

static SpectrumWifiPhyTestSuite spectrumWifiPhyTestSuite;