A Discrete-Event Network Simulator
API
spectrum-ideal-phy-test.cc
Go to the documentation of this file.
1 /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2011 CTTC
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Nicola Baldo <nbaldo@cttc.es>
19  */
20 
21 #include <ns3/object.h>
22 #include <ns3/spectrum-interference.h>
23 #include <ns3/spectrum-error-model.h>
24 #include <ns3/log.h>
25 #include <ns3/test.h>
26 #include <ns3/simulator.h>
27 #include <ns3/packet.h>
28 #include <ns3/ptr.h>
29 #include <ns3/string.h>
30 #include <iostream>
31 #include <ns3/math.h>
32 #include <ns3/spectrum-model-ism2400MHz-res1MHz.h>
33 #include <ns3/spectrum-model-300kHz-300GHz-log.h>
34 #include <ns3/wifi-spectrum-value-helper.h>
35 #include <ns3/single-model-spectrum-channel.h>
36 #include <ns3/waveform-generator.h>
37 #include <ns3/spectrum-analyzer.h>
38 #include <string>
39 #include <iomanip>
40 #include <ns3/friis-spectrum-propagation-loss.h>
41 #include <ns3/propagation-delay-model.h>
42 #include <ns3/spectrum-helper.h>
43 #include <ns3/adhoc-aloha-noack-ideal-phy-helper.h>
44 #include <ns3/mobility-helper.h>
45 #include <ns3/data-rate.h>
46 #include <ns3/uinteger.h>
47 #include <ns3/packet-socket-helper.h>
48 #include <ns3/packet-socket-address.h>
49 #include <ns3/packet-socket-client.h>
50 #include <ns3/config.h>
51 
52 
53 using namespace ns3;
54 
55 NS_LOG_COMPONENT_DEFINE ("SpectrumIdealPhyTest");
56 
57 static uint64_t g_rxBytes;
58 static double g_bandwidth = 20e6; // Hz
59 
60 void
61 PhyRxEndOkTrace (std::string context, Ptr<const Packet> p)
62 {
63  g_rxBytes += p->GetSize ();
64 }
65 
66 
73 {
74 public:
82  SpectrumIdealPhyTestCase (double snrLinear,
83  uint64_t phyRate,
84  bool rateIsAchievable,
85  std::string channelType);
86  virtual ~SpectrumIdealPhyTestCase ();
87 
88 private:
89  virtual void DoRun (void);
97  static std::string Name (std::string channelType, double snrLinear, uint64_t phyRate);
98 
99  double m_snrLinear;
100  uint64_t m_phyRate;
102  std::string m_channelType;
103 };
104 
105 std::string
106 SpectrumIdealPhyTestCase::Name (std::string channelType, double snrLinear, uint64_t phyRate)
107 {
108  std::ostringstream oss;
109  oss << channelType
110  << " snr = " << snrLinear << " (linear), "
111  << " phyRate = " << phyRate << " bps";
112  return oss.str();
113 }
114 
115 
117  uint64_t phyRate,
118  bool rateIsAchievable,
119  std::string channelType)
120  : TestCase (Name (channelType, snrLinear, phyRate)),
121  m_snrLinear (snrLinear),
122  m_phyRate (phyRate),
123  m_rateIsAchievable (rateIsAchievable),
124  m_channelType (channelType)
125 {
126 }
127 
129 {
130 }
131 
132 
133 void
135 {
137  double txPowerW = 0.1;
138  // for the noise, we use the Power Spectral Density of thermal noise
139  // at room temperature. The value of the PSD will be constant over the band of interest.
140  const double k = 1.381e-23; //Boltzmann's constant
141  const double T = 290; // temperature in Kelvin
142  double noisePsdValue = k * T; // W/Hz
143  double lossLinear = (txPowerW) / (m_snrLinear * noisePsdValue * g_bandwidth);
144  double lossDb = 10 * std::log10 (lossLinear);
145  uint64_t phyRate = m_phyRate; // bps
146  uint32_t pktSize = 50; // bytes
147 
148  uint32_t numPkts = 200; //desired number of packets in the
149  //test. Directly related with the accuracy
150  //of the measurement.
151 
152  double testDuration = (numPkts * pktSize * 8.0) / phyRate;
153  NS_LOG_INFO ("test duration = " << std::fixed << testDuration);
154 
155  NodeContainer c;
156  c.Create (2);
157 
159  Ptr<ListPositionAllocator> positionAlloc = CreateObject<ListPositionAllocator> ();
160  positionAlloc->Add (Vector (0.0, 0.0, 0.0));
161  positionAlloc->Add (Vector (5.0, 0.0, 0.0));
162  mobility.SetPositionAllocator (positionAlloc);
163  mobility.SetMobilityModel ("ns3::ConstantPositionMobilityModel");
164 
165 
166  mobility.Install (c);
167 
168 
169  SpectrumChannelHelper channelHelper;
170  channelHelper.SetChannel (m_channelType);
171  channelHelper.SetPropagationDelay ("ns3::ConstantSpeedPropagationDelayModel");
172  Ptr<MatrixPropagationLossModel> propLoss = CreateObject<MatrixPropagationLossModel> ();
173  propLoss->SetLoss (c.Get(0)->GetObject<MobilityModel> (), c.Get(1)->GetObject<MobilityModel> (), lossDb, true);
174  channelHelper.AddPropagationLoss (propLoss);
175  Ptr<SpectrumChannel> channel = channelHelper.Create ();
176 
177 
179 
180  uint32_t channelNumber = 1;
181  Ptr<SpectrumValue> txPsd = sf.CreateTxPowerSpectralDensity (txPowerW, channelNumber);
182 
183  Ptr<SpectrumValue> noisePsd = sf.CreateConstant (noisePsdValue);
184 
185  AdhocAlohaNoackIdealPhyHelper deviceHelper;
186  deviceHelper.SetChannel (channel);
187  deviceHelper.SetTxPowerSpectralDensity (txPsd);
188  deviceHelper.SetNoisePowerSpectralDensity (noisePsd);
189  deviceHelper.SetPhyAttribute ("Rate", DataRateValue (DataRate (phyRate)));
190  NetDeviceContainer devices = deviceHelper.Install (c);
191 
192  PacketSocketHelper packetSocket;
193  packetSocket.Install (c);
194 
195  PacketSocketAddress socket;
196  socket.SetSingleDevice (devices.Get (0)->GetIfIndex ());
197  socket.SetPhysicalAddress (devices.Get (1)->GetAddress ());
198  socket.SetProtocol (1);
199 
200  Ptr<PacketSocketClient> client = CreateObject<PacketSocketClient> ();
201  client->SetRemote (socket);
202  client->SetAttribute ("Interval", TimeValue (Seconds (double (pktSize*8) / (1.2*double (phyRate)))));
203  client->SetAttribute ("PacketSize", UintegerValue (pktSize));
204  client->SetAttribute ("MaxPackets", UintegerValue (0));
205  client->SetStartTime(Seconds (0.0));
206  client->SetStopTime(Seconds (testDuration));
207  c.Get (0)->AddApplication (client);
208 
209  Config::Connect ("/NodeList/*/DeviceList/*/Phy/RxEndOk", MakeCallback (&PhyRxEndOkTrace));
210 
211  g_rxBytes = 0;
212  Simulator::Stop (Seconds (testDuration+0.000000001));
213  Simulator::Run ();
214  double throughputBps = (g_rxBytes * 8.0) / testDuration;
215 
216  std::clog.unsetf(std::ios_base::floatfield);
217 
218  if (m_rateIsAchievable)
219  {
220  NS_TEST_ASSERT_MSG_EQ_TOL (throughputBps, m_phyRate, m_phyRate*0.01, "throughput does not match PHY rate");
221  }
222  else
223  {
224  NS_TEST_ASSERT_MSG_EQ (throughputBps, 0.0, "PHY rate is not achievable but throughput is non-zero");
225  }
226 
227  Simulator::Destroy ();
228 }
229 
230 
231 
238 {
239 public:
241 };
242 
244  : TestSuite ("spectrum-ideal-phy", SYSTEM)
245 {
246 
247  NS_LOG_INFO ("creating SpectrumIdealPhyTestSuite");
248 
249  for (double snr = 0.01; snr <= 10 ; snr *= 2)
250  {
251  double achievableRate = g_bandwidth*log2(1+snr);
252  AddTestCase (new SpectrumIdealPhyTestCase (snr, static_cast<uint64_t> (achievableRate*0.1), true, "ns3::SingleModelSpectrumChannel"), TestCase::QUICK);
253  AddTestCase (new SpectrumIdealPhyTestCase (snr, static_cast<uint64_t> (achievableRate*0.5), true, "ns3::SingleModelSpectrumChannel"), TestCase::QUICK);
254  AddTestCase (new SpectrumIdealPhyTestCase (snr, static_cast<uint64_t> (achievableRate*0.95), true, "ns3::SingleModelSpectrumChannel"), TestCase::QUICK);
255  AddTestCase (new SpectrumIdealPhyTestCase (snr, static_cast<uint64_t> (achievableRate*1.05), false, "ns3::SingleModelSpectrumChannel"), TestCase::QUICK);
256  AddTestCase (new SpectrumIdealPhyTestCase (snr, static_cast<uint64_t> (achievableRate*2), false, "ns3::SingleModelSpectrumChannel"), TestCase::QUICK);
257  AddTestCase (new SpectrumIdealPhyTestCase (snr, static_cast<uint64_t> (achievableRate*4), false, "ns3::SingleModelSpectrumChannel"), TestCase::QUICK);
258  }
259  for (double snr = 0.01; snr <= 10 ; snr *= 10)
260  {
261  double achievableRate = g_bandwidth*log2(1+snr);
262  AddTestCase (new SpectrumIdealPhyTestCase (snr, static_cast<uint64_t> (achievableRate*0.1), true, "ns3::MultiModelSpectrumChannel"), TestCase::QUICK);
263  AddTestCase (new SpectrumIdealPhyTestCase (snr, static_cast<uint64_t> (achievableRate*0.5), true, "ns3::MultiModelSpectrumChannel"), TestCase::QUICK);
264  AddTestCase (new SpectrumIdealPhyTestCase (snr, static_cast<uint64_t> (achievableRate*0.95), true, "ns3::MultiModelSpectrumChannel"), TestCase::QUICK);
265  AddTestCase (new SpectrumIdealPhyTestCase (snr, static_cast<uint64_t> (achievableRate*1.05), false, "ns3::MultiModelSpectrumChannel"), TestCase::QUICK);
266  AddTestCase (new SpectrumIdealPhyTestCase (snr, static_cast<uint64_t> (achievableRate*2), false, "ns3::MultiModelSpectrumChannel"), TestCase::QUICK);
267  AddTestCase (new SpectrumIdealPhyTestCase (snr, static_cast<uint64_t> (achievableRate*4), false, "ns3::MultiModelSpectrumChannel"), TestCase::QUICK);
268  }
269 }
270 
Ideal Spectrum PHY Test.
virtual void DoRun(void)
Implementation to actually run this TestCase.
static std::string Name(std::string channelType, double snrLinear, uint64_t phyRate)
Get the test name.
bool m_rateIsAchievable
Check if the rate is achievable.
uint64_t m_phyRate
PHY rate (bps)
std::string m_channelType
Channel type.
SpectrumIdealPhyTestCase(double snrLinear, uint64_t phyRate, bool rateIsAchievable, std::string channelType)
Constructor.
Ideal Spectrum PHY TestSuite.
void SetPhyAttribute(std::string name, const AttributeValue &v)
void SetTxPowerSpectralDensity(Ptr< SpectrumValue > txPsd)
void SetNoisePowerSpectralDensity(Ptr< SpectrumValue > noisePsd)
void SetChannel(Ptr< SpectrumChannel > channel)
set the SpectrumChannel that will be used by SpectrumPhy instances created by this helper
NetDeviceContainer Install(NodeContainer c) const
Class for representing data rates.
Definition: data-rate.h:89
AttributeValue implementation for DataRate.
Definition: data-rate.h:298
Helper class used to assign positions and mobility models to nodes.
Keep track of the current position and velocity of an object.
holds a vector of ns3::NetDevice pointers
keep track of a set of node pointers.
void Create(uint32_t n)
Create n nodes and append pointers to them to the end of this NodeContainer.
Ptr< Node > Get(uint32_t i) const
Get the Ptr<Node> stored in this container at a given index.
uint32_t AddApplication(Ptr< Application > application)
Associate an Application to this Node.
Definition: node.cc:159
Ptr< T > GetObject(void) const
Get a pointer to the requested aggregated Object.
Definition: object.h:470
uint32_t GetSize(void) const
Returns the the size in bytes of the packet (including the zero-filled initial payload).
Definition: packet.h:856
an address for a packet socket
void SetProtocol(uint16_t protocol)
Set the protocol.
void SetPhysicalAddress(const Address address)
Set the destination address.
void SetSingleDevice(uint32_t device)
Set the address to match only a specified NetDevice.
Give ns3::PacketSocket powers to ns3::Node.
void Install(Ptr< Node > node) const
Aggregate an instance of a ns3::PacketSocketFactory onto the provided node.
Setup a SpectrumChannel.
void SetChannel(std::string type, std::string n0="", const AttributeValue &v0=EmptyAttributeValue(), std::string n1="", const AttributeValue &v1=EmptyAttributeValue(), std::string n2="", const AttributeValue &v2=EmptyAttributeValue(), std::string n3="", const AttributeValue &v3=EmptyAttributeValue(), std::string n4="", const AttributeValue &v4=EmptyAttributeValue(), std::string n5="", const AttributeValue &v5=EmptyAttributeValue(), std::string n6="", const AttributeValue &v6=EmptyAttributeValue(), std::string n7="", const AttributeValue &v7=EmptyAttributeValue())
void SetPropagationDelay(std::string name, std::string n0="", const AttributeValue &v0=EmptyAttributeValue(), std::string n1="", const AttributeValue &v1=EmptyAttributeValue(), std::string n2="", const AttributeValue &v2=EmptyAttributeValue(), std::string n3="", const AttributeValue &v3=EmptyAttributeValue(), std::string n4="", const AttributeValue &v4=EmptyAttributeValue(), std::string n5="", const AttributeValue &v5=EmptyAttributeValue(), std::string n6="", const AttributeValue &v6=EmptyAttributeValue(), std::string n7="", const AttributeValue &v7=EmptyAttributeValue())
void AddPropagationLoss(std::string name, std::string n0="", const AttributeValue &v0=EmptyAttributeValue(), std::string n1="", const AttributeValue &v1=EmptyAttributeValue(), std::string n2="", const AttributeValue &v2=EmptyAttributeValue(), std::string n3="", const AttributeValue &v3=EmptyAttributeValue(), std::string n4="", const AttributeValue &v4=EmptyAttributeValue(), std::string n5="", const AttributeValue &v5=EmptyAttributeValue(), std::string n6="", const AttributeValue &v6=EmptyAttributeValue(), std::string n7="", const AttributeValue &v7=EmptyAttributeValue())
Ptr< SpectrumChannel > Create(void) const
encapsulates test code
Definition: test.h:994
void AddTestCase(TestCase *testCase, TestDuration duration=QUICK)
Add an individual child TestCase to this test suite.
Definition: test.cc:299
A suite of tests to run.
Definition: test.h:1188
AttributeValue implementation for Time.
Definition: nstime.h:1308
Hold an unsigned integer type.
Definition: uinteger.h:44
Implements Wifi SpectrumValue for the 2.4 GHz ISM band only, with a 5 MHz spectrum resolution.
virtual Ptr< SpectrumValue > CreateConstant(double psd)
Creates a SpectrumValue instance with a constant value for all frequencies.
virtual Ptr< SpectrumValue > CreateTxPowerSpectralDensity(double txPower, uint8_t channel)
Creates a SpectrumValue instance that represents the TX Power Spectral Density of a wifi device corre...
void Connect(std::string path, const CallbackBase &cb)
Definition: config.cc:920
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:205
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition: log.h:281
#define NS_TEST_ASSERT_MSG_EQ(actual, limit, msg)
Test that an actual and expected (limit) value are equal and report and abort if not.
Definition: test.h:141
#define NS_TEST_ASSERT_MSG_EQ_TOL(actual, limit, tol, msg)
Test that actual and expected (limit) values are equal to plus or minus some tolerance and report and...
Definition: test.h:323
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1244
devices
Definition: first.py:39
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Callback< R, Ts... > MakeCallback(R(T::*memPtr)(Ts...), OBJ objPtr)
Build Callbacks for class method members which take varying numbers of arguments and potentially retu...
Definition: callback.h:1648
channel
Definition: third.py:92
mobility
Definition: third.py:108
void PhyRxEndOkTrace(std::string context, Ptr< const Packet > p)
static SpectrumIdealPhyTestSuite g_spectrumIdealPhyTestSuite
Static variable for test initialization.
static uint64_t g_rxBytes
static double g_bandwidth
static std::string Name(std::string str, uint32_t totalStreamSize, uint32_t sourceWriteSize, uint32_t serverReadSize, uint32_t serverWriteSize, uint32_t sourceReadSize, bool useIpv6)
Definition: tcp-test.cc:166
uint32_t pktSize
packet size used for the simulation (in bytes)
Definition: wifi-bianchi.cc:89