A Discrete-Event Network Simulator
API
rraa-wifi-manager.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2004,2005,2006 INRIA
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: Federico Maguolo <maguolof@dei.unipd.it>
19  */
20 
21 #include "ns3/log.h"
22 #include "ns3/packet.h"
23 #include "ns3/simulator.h"
24 #include "rraa-wifi-manager.h"
25 #include "wifi-phy.h"
26 #include "wifi-mac.h"
27 
28 #define Min(a,b) ((a < b) ? a : b)
29 
30 namespace ns3 {
31 
32 NS_LOG_COMPONENT_DEFINE ("RraaWifiManager");
33 
41 {
42  uint32_t m_counter;
43  uint32_t m_nFailed;
44  uint32_t m_adaptiveRtsWnd;
45  uint32_t m_rtsCounter;
50  uint8_t m_nRate;
51  uint8_t m_rateIndex;
52 
54 };
55 
57 
58 TypeId
60 {
61  static TypeId tid = TypeId ("ns3::RraaWifiManager")
63  .SetGroupName ("Wifi")
64  .AddConstructor<RraaWifiManager> ()
65  .AddAttribute ("Basic",
66  "If true the RRAA-BASIC algorithm will be used, otherwise the RRAA will be used",
67  BooleanValue (false),
70  .AddAttribute ("Timeout",
71  "Timeout for the RRAA BASIC loss estimation block (s)",
72  TimeValue (Seconds (0.05)),
74  MakeTimeChecker ())
75  .AddAttribute ("FrameLength",
76  "The data frame length (in bytes) used for calculating mode TxTime.",
77  UintegerValue (1420),
79  MakeUintegerChecker <uint32_t> ())
80  .AddAttribute ("AckFrameLength",
81  "The ACK frame length (in bytes) used for calculating mode TxTime.",
82  UintegerValue (14),
84  MakeUintegerChecker <uint32_t> ())
85  .AddAttribute ("Alpha",
86  "Constant for calculating the MTL threshold.",
87  DoubleValue (1.25),
89  MakeDoubleChecker<double> (1))
90  .AddAttribute ("Beta",
91  "Constant for calculating the ORI threshold.",
92  DoubleValue (2),
94  MakeDoubleChecker<double> (1))
95  .AddAttribute ("Tau",
96  "Constant for calculating the EWND size.",
97  DoubleValue (0.012),
99  MakeDoubleChecker<double> (0))
100  .AddTraceSource ("Rate",
101  "Traced value for rate changes (b/s)",
103  "ns3::TracedValueCallback::Uint64")
104  ;
105  return tid;
106 }
107 
108 
111  m_currentRate (0)
112 {
113  NS_LOG_FUNCTION (this);
114 }
115 
117 {
118  NS_LOG_FUNCTION (this);
119 }
120 
121 void
123 {
124  NS_LOG_FUNCTION (this << phy);
125  uint8_t nModes = phy->GetNModes ();
126  for (uint8_t i = 0; i < nModes; i++)
127  {
128  WifiMode mode = phy->GetMode (i);
129  WifiTxVector txVector;
130  txVector.SetMode (mode);
132  /* Calculate the TX Time of the data and the corresponding ACK*/
133  Time dataTxTime = phy->CalculateTxDuration (m_frameLength, txVector, phy->GetFrequency ());
134  Time ackTxTime = phy->CalculateTxDuration (m_ackLength, txVector, phy->GetFrequency ());
135  NS_LOG_DEBUG ("Calculating TX times: Mode= " << mode << " DataTxTime= " << dataTxTime << " AckTxTime= " << ackTxTime);
136  AddCalcTxTime (mode, dataTxTime + ackTxTime);
137  }
139 }
140 
141 void
143 {
144  NS_LOG_FUNCTION (this);
145  m_sifs = mac->GetSifs ();
146  m_difs = m_sifs + 2 * mac->GetSlot ();
148 }
149 
150 Time
152 {
153  NS_LOG_FUNCTION (this << mode);
154  for (TxTime::const_iterator i = m_calcTxTime.begin (); i != m_calcTxTime.end (); i++)
155  {
156  if (mode == i->second)
157  {
158  return i->first;
159  }
160  }
161  NS_ASSERT (false);
162  return Seconds (0);
163 }
164 
165 void
167 {
168  NS_LOG_FUNCTION (this << mode << t);
169  m_calcTxTime.push_back (std::make_pair (t, mode));
170 }
171 
174 {
175  NS_LOG_FUNCTION (this << station << mode);
176  struct WifiRraaThresholds threshold;
177  for (RraaThresholdsTable::const_iterator i = station->m_thresholds.begin (); i != station->m_thresholds.end (); i++)
178  {
179  if (mode == i->second)
180  {
181  return i->first;
182  }
183  }
184  NS_ABORT_MSG ("No thresholds for mode " << mode << " found");
185  return threshold; // Silence compiler warning
186 }
187 
190 {
192  station->m_initialized = false;
193  station->m_adaptiveRtsWnd = 0;
194  station->m_rtsCounter = 0;
195  station->m_adaptiveRtsOn = false;
196  station->m_lastFrameFail = false;
197  return station;
198 }
199 
200 void
202 {
203  NS_LOG_FUNCTION (this << station);
204  if (!station->m_initialized)
205  {
206  //Note: we appear to be doing late initialization of the table
207  //to make sure that the set of supported rates has been initialized
208  //before we perform our own initialization.
209  station->m_nRate = GetNSupported (station);
210  //Initialize at maximal rate
211  station->m_rateIndex = GetMaxRate (station);
212 
213  station->m_initialized = true;
214 
215  station->m_thresholds = RraaThresholdsTable (station->m_nRate);
216  InitThresholds (station);
217  ResetCountersBasic (station);
218  }
219 }
220 
221 void
223 {
224  NS_LOG_FUNCTION (this << station);
225  NS_LOG_DEBUG ("InitThresholds = " << station);
226 
227  double nextCritical = 0;
228  double nextMtl = 0;
229  double mtl = 0;
230  double ori = 0;
231  for (uint8_t i = 0; i < station->m_nRate; i++)
232  {
233  WifiMode mode = GetSupported (station, i);
234  Time totalTxTime = GetCalcTxTime (mode) + m_sifs + m_difs;
235  if (i == GetMaxRate (station))
236  {
237  ori = 0;
238  }
239  else
240  {
241  WifiMode nextMode = GetSupported (station, i + 1);
242  Time nextTotalTxTime = GetCalcTxTime (nextMode) + m_sifs + m_difs;
243  nextCritical = 1 - (nextTotalTxTime.GetSeconds () / totalTxTime.GetSeconds ());
244  nextMtl = m_alpha * nextCritical;
245  ori = nextMtl / m_beta;
246  }
247  if (i == 0)
248  {
249  mtl = 1;
250  }
252  th.m_ewnd = static_cast<uint32_t> (ceil (m_tau / totalTxTime.GetSeconds ()));
253  th.m_ori = ori;
254  th.m_mtl = mtl;
255  station->m_thresholds.push_back (std::make_pair (th, mode));
256  mtl = nextMtl;
257  NS_LOG_DEBUG (mode << " " << th.m_ewnd << " " << th.m_mtl << " " << th.m_ori);
258  }
259 }
260 
261 void
263 {
264  NS_LOG_FUNCTION (this << station);
265  station->m_nFailed = 0;
266  station->m_counter = GetThresholds (station, station->m_rateIndex).m_ewnd;
267  station->m_lastReset = Simulator::Now ();
268 }
269 
270 uint8_t
272 {
273  return station->m_nRate - 1;
274 }
275 
276 void
278 {
279  NS_LOG_FUNCTION (this << st);
280 }
281 
282 void
284 {
285  NS_LOG_FUNCTION (this << st);
287  station->m_lastFrameFail = true;
288  CheckTimeout (station);
289  station->m_counter--;
290  station->m_nFailed++;
291  RunBasicAlgorithm (station);
292 }
293 
294 void
296  double rxSnr, WifiMode txMode)
297 {
298  NS_LOG_FUNCTION (this << st << rxSnr << txMode);
299 }
300 
301 void
303  double ctsSnr, WifiMode ctsMode, double rtsSnr)
304 {
305  NS_LOG_FUNCTION (this << st << ctsSnr << ctsMode << rtsSnr);
306 }
307 
308 void
310  double ackSnr, WifiMode ackMode, double dataSnr)
311 {
312  NS_LOG_FUNCTION (this << st << ackSnr << ackMode << dataSnr);
314  station->m_lastFrameFail = false;
315  CheckTimeout (station);
316  station->m_counter--;
317  RunBasicAlgorithm (station);
318 }
319 
320 void
322 {
323  NS_LOG_FUNCTION (this << st);
324 }
325 
326 void
328 {
329  NS_LOG_FUNCTION (this << st);
330 }
331 
334 {
335  NS_LOG_FUNCTION (this << st);
337  uint16_t channelWidth = GetChannelWidth (station);
338  if (channelWidth > 20 && channelWidth != 22)
339  {
340  //avoid to use legacy rate adaptation algorithms for IEEE 802.11n/ac
341  channelWidth = 20;
342  }
343  CheckInit (station);
344  WifiMode mode = GetSupported (station, station->m_rateIndex);
345  if (m_currentRate != mode.GetDataRate (channelWidth))
346  {
347  NS_LOG_DEBUG ("New datarate: " << mode.GetDataRate (channelWidth));
348  m_currentRate = mode.GetDataRate (channelWidth);
349  }
350  return WifiTxVector (mode, GetDefaultTxPowerLevel (), GetPreambleForTransmission (mode, GetAddress (station)), 800, 1, 1, 0, channelWidth, GetAggregation (station), false);
351 }
352 
355 {
356  NS_LOG_FUNCTION (this << st);
358  uint16_t channelWidth = GetChannelWidth (station);
359  if (channelWidth > 20 && channelWidth != 22)
360  {
361  //avoid to use legacy rate adaptation algorithms for IEEE 802.11n/ac
362  channelWidth = 20;
363  }
364  WifiTxVector rtsTxVector;
365  WifiMode mode;
366  if (GetUseNonErpProtection () == false)
367  {
368  mode = GetSupported (station, 0);
369  }
370  else
371  {
372  mode = GetNonErpSupported (station, 0);
373  }
374  rtsTxVector = WifiTxVector (mode, GetDefaultTxPowerLevel (), GetPreambleForTransmission (mode, GetAddress (station)), 800, 1, 1, 0, channelWidth, GetAggregation (station), false);
375  return rtsTxVector;
376 }
377 
378 bool
380  Ptr<const Packet> packet, bool normally)
381 {
382  NS_LOG_FUNCTION (this << st << packet << normally);
384  CheckInit (station);
385  if (m_basic)
386  {
387  return normally;
388  }
389  ARts (station);
390  return station->m_adaptiveRtsOn;
391 }
392 
393 void
395 {
396  NS_LOG_FUNCTION (this << station);
397  Time d = Simulator::Now () - station->m_lastReset;
398  if (station->m_counter == 0 || d > m_timeout)
399  {
400  ResetCountersBasic (station);
401  }
402 }
403 
404 void
406 {
407  NS_LOG_FUNCTION (this << station);
408  WifiRraaThresholds thresholds = GetThresholds (station, station->m_rateIndex);
409  double ploss = (station->m_nFailed / thresholds.m_ewnd);
410  if (station->m_counter == 0
411  || ploss > thresholds.m_mtl)
412  {
413  if (ploss > thresholds.m_mtl)
414  {
415  station->m_rateIndex--;
416  }
417  else if (station->m_rateIndex < GetMaxRate (station)
418  && ploss < thresholds.m_ori)
419  {
420  station->m_rateIndex++;
421  }
422  ResetCountersBasic (station);
423  }
424 }
425 
426 void
428 {
429  if (!station->m_adaptiveRtsOn
430  && station->m_lastFrameFail)
431  {
432  station->m_adaptiveRtsWnd++;
433  station->m_rtsCounter = station->m_adaptiveRtsWnd;
434  }
435  else if ((station->m_adaptiveRtsOn && station->m_lastFrameFail)
436  || (!station->m_adaptiveRtsOn && !station->m_lastFrameFail))
437  {
438  station->m_adaptiveRtsWnd = station->m_adaptiveRtsWnd / 2;
439  station->m_rtsCounter = station->m_adaptiveRtsWnd;
440  }
441  if (station->m_rtsCounter > 0)
442  {
443  station->m_adaptiveRtsOn = true;
444  station->m_rtsCounter--;
445  }
446  else
447  {
448  station->m_adaptiveRtsOn = false;
449  }
450 }
451 
454 {
455  NS_LOG_FUNCTION (this << station << +rate);
456  WifiMode mode = GetSupported (station, rate);
457  return GetThresholds (station, mode);
458 }
459 
460 bool
462 {
463  return true;
464 }
465 
466 void
468 {
469  //HT is not supported by this algorithm.
470  if (enable)
471  {
472  NS_FATAL_ERROR ("WifiRemoteStationManager selected does not support HT rates");
473  }
474 }
475 
476 void
478 {
479  //VHT is not supported by this algorithm.
480  if (enable)
481  {
482  NS_FATAL_ERROR ("WifiRemoteStationManager selected does not support VHT rates");
483  }
484 }
485 
486 void
488 {
489  //HE is not supported by this algorithm.
490  if (enable)
491  {
492  NS_FATAL_ERROR ("WifiRemoteStationManager selected does not support HE rates");
493  }
494 }
495 
496 } //namespace ns3
virtual void SetupMac(const Ptr< WifiMac > mac)
Set up MAC associated with this device since it is the object that knows the full set of timing param...
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:102
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by "...
uint64_t GetDataRate(uint16_t channelWidth, uint16_t guardInterval, uint8_t nss) const
Definition: wifi-mode.cc:156
AttributeValue implementation for Boolean.
Definition: boolean.h:36
#define NS_ABORT_MSG(msg)
Unconditional abnormal program termination with a message.
Definition: abort.h:50
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:45
void DoReportRxOk(WifiRemoteStation *station, double rxSnr, WifiMode txMode)
This method is a pure virtual method that must be implemented by the sub-class.
bool GetUseNonErpProtection(void) const
Return whether the device supports protection of non-ERP stations.
Ptr< const AttributeAccessor > MakeBooleanAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Definition: boolean.h:84
double m_tau
Tau value for RRAA (value for calculating EWND size).
static TypeId GetTypeId(void)
Get the type ID.
void DoReportRtsOk(WifiRemoteStation *station, double ctsSnr, WifiMode ctsMode, double rtsSnr)
This method is a pure virtual method that must be implemented by the sub-class.
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file...
Definition: assert.h:67
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
void RunBasicAlgorithm(RraaWifiRemoteStation *station)
Find an appropriate rate for the given station, using a basic algorithm.
TracedValue< uint64_t > m_currentRate
Trace rate changes.
uint32_t m_ewnd
Evaluation Window.
bool DoNeedRts(WifiRemoteStation *st, Ptr< const Packet > packet, bool normally)
#define NS_FATAL_ERROR(msg)
Report a fatal error with a message and terminate.
Definition: fatal-error.h:162
bool IsLowLatency(void) const
void DoReportRtsFailed(WifiRemoteStation *station)
This method is a pure virtual method that must be implemented by the sub-class.
void ResetCountersBasic(RraaWifiRemoteStation *station)
Reset the counters of the given station.
uint16_t GetFrequency(void) const
Definition: wifi-phy.cc:1235
represent a single transmission modeA WifiMode is implemented by a single integer which is used to lo...
Definition: wifi-mode.h:97
bool GetAggregation(const WifiRemoteStation *station) const
Return whether the given station supports A-MPDU.
WifiTxVector DoGetRtsTxVector(WifiRemoteStation *station)
Ptr< const TraceSourceAccessor > MakeTraceSourceAccessor(T a)
Create a TraceSourceAccessor which will control access to the underlying trace source.
phy
Definition: third.py:86
WifiRemoteStation * DoCreateStation(void) const
Ptr< const AttributeChecker > MakeTimeChecker(const Time min, const Time max)
Helper to make a Time checker with bounded range.
Definition: time.cc:446
bool m_adaptiveRtsOn
Check if Adaptive RTS mechanism is on.
Time CalculateTxDuration(uint32_t size, WifiTxVector txVector, uint16_t frequency)
Definition: wifi-phy.cc:2226
double GetSeconds(void) const
Get an approximation of the time stored in this instance in the indicated unit.
Definition: nstime.h:355
void CheckInit(RraaWifiRemoteStation *station)
Check for initializations.
uint32_t m_frameLength
Data frame length used for calculate mode TxTime.
void CheckTimeout(RraaWifiRemoteStation *station)
Check if the counter should be reset.
double m_beta
Beta value for RRAA (value for calculating ORI threshold).
AttributeValue implementation for Time.
Definition: nstime.h:1069
void DoReportDataFailed(WifiRemoteStation *station)
This method is a pure virtual method that must be implemented by the sub-class.
Hold an unsigned integer type.
Definition: uinteger.h:44
WifiTxVector DoGetDataTxVector(WifiRemoteStation *station)
WifiPreamble GetPreambleForTransmission(WifiMode mode, Mac48Address dest)
Return the preamble to be used for the transmission.
void SetHtSupported(bool enable)
Enable or disable HT capability support.
uint32_t m_counter
Counter for transmission attempts.
uint8_t m_nRate
Number of supported rates.
mac
Definition: third.py:92
uint32_t m_rtsCounter
Counter for RTS transmission attempts.
WifiMode GetMode(uint8_t mode) const
The WifiPhy::GetNModes() and WifiPhy::GetMode() methods are used (e.g., by a WifiRemoteStationManager...
Definition: wifi-phy.cc:3501
std::vector< std::pair< WifiRraaThresholds, WifiMode > > RraaThresholdsTable
List of thresholds for each mode.
Mac48Address GetAddress(const WifiRemoteStation *station) const
Return the address of the station.
virtual void SetupPhy(const Ptr< WifiPhy > phy)
Set up PHY associated with this device since it is the object that knows the full set of transmit rat...
hold a list of per-remote-station state.
Robust Rate Adaptation AlgorithmThis is an implementation of RRAA as described in "Robust rate adapta...
Time GetCalcTxTime(WifiMode mode) const
Get the estimated TxTime of a packet with a given mode.
RraaThresholdsTable m_thresholds
RRAA thresholds for this station.
double m_alpha
Alpha value for RRAA (value for calculating MTL threshold)
bool m_initialized
For initializing variables.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
void SetPreambleType(WifiPreamble preamble)
Sets the preamble type.
Ptr< const AttributeChecker > MakeBooleanChecker(void)
Definition: boolean.cc:121
TxTime m_calcTxTime
To hold all the calculated TxTime for all modes.
uint32_t m_ackLength
Ack frame length used for calculate mode TxTime.
Ptr< const AttributeAccessor > MakeTimeAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Definition: nstime.h:1070
static Time Now(void)
Return the current simulation virtual time.
Definition: simulator.cc:249
void SetVhtSupported(bool enable)
Enable or disable VHT capability support.
WifiMode GetSupported(const WifiRemoteStation *station, uint8_t i) const
Return whether mode associated with the specified station at the specified index. ...
double m_ori
Opportunistic Rate Increase threshold.
void ARts(RraaWifiRemoteStation *station)
Activate the use of RTS for the given station if the conditions are met.
void DoReportDataOk(WifiRemoteStation *station, double ackSnr, WifiMode ackMode, double dataSnr)
This method is a pure virtual method that must be implemented by the sub-class.
void SetMode(WifiMode mode)
Sets the selected payload transmission mode.
Time m_sifs
Value of SIFS configured in the device.
Ptr< const AttributeAccessor > MakeDoubleAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Definition: double.h:42
Time m_difs
Value of DIFS configured in the device.
virtual void SetupMac(const Ptr< WifiMac > mac)
Set up MAC associated with this device since it is the object that knows the full set of timing param...
WifiMode GetNonErpSupported(const WifiRemoteStation *station, uint8_t i) const
Return whether non-ERP mode associated with the specified station at the specified index...
WifiRraaThresholds structure.
void AddCalcTxTime(WifiMode mode, Time t)
Add transmission time for the given mode to an internal list.
uint8_t m_rateIndex
Current rate index.
Time m_lastReset
Time of the last reset.
uint32_t m_adaptiveRtsWnd
Window size for the Adaptive RTS mechanism.
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
Definition: log.h:270
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1007
void InitThresholds(RraaWifiRemoteStation *station)
Initialize the thresholds internal list for the given station.
void SetHeSupported(bool enable)
Enable or disable HE capability support.
uint8_t GetNSupported(const WifiRemoteStation *station) const
Return the number of modes supported by the given station.
hold per-remote-station state for RRAA Wifi manager.
WifiRraaThresholds GetThresholds(RraaWifiRemoteStation *station, WifiMode mode) const
Get the thresholds for the given station and mode.
bool m_lastFrameFail
Flag if the last frame sent has failed.
uint8_t GetMaxRate(RraaWifiRemoteStation *station) const
Return the index for the maximum transmission rate for the given station.
double m_mtl
Maximum Tolerable Loss threshold.
void DoReportFinalDataFailed(WifiRemoteStation *station)
This method is a pure virtual method that must be implemented by the sub-class.
void DoReportFinalRtsFailed(WifiRemoteStation *station)
This method is a pure virtual method that must be implemented by the sub-class.
This class can be used to hold variables of floating point type such as &#39;double&#39; or &#39;float&#39;...
Definition: double.h:41
Ptr< const AttributeAccessor > MakeUintegerAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Definition: uinteger.h:45
a unique identifier for an interface.
Definition: type-id.h:58
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:915
hold per-remote-station state.
uint8_t GetNModes(void) const
The WifiPhy::GetNModes() and WifiPhy::GetMode() methods are used (e.g., by a WifiRemoteStationManager...
Definition: wifi-phy.cc:3495
virtual void SetupPhy(const Ptr< WifiPhy > phy)
Set up PHY associated with this device since it is the object that knows the full set of transmit rat...
uint32_t m_nFailed
Number of failed transmission attempts.
uint16_t GetChannelWidth(const WifiRemoteStation *station) const
Return the channel width supported by the station.