A Discrete-Event Network Simulator
API
aarfcd-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 "aarfcd-wifi-manager.h"
24 #include "wifi-tx-vector.h"
25 
26 #define Min(a,b) ((a < b) ? a : b)
27 #define Max(a,b) ((a > b) ? a : b)
28 
29 namespace ns3 {
30 
31 NS_LOG_COMPONENT_DEFINE ("AarfcdWifiManager");
32 
40 {
41  uint32_t m_timer;
42  uint32_t m_success;
43  uint32_t m_failed;
44  bool m_recovery;
46  uint32_t m_retry;
47  uint32_t m_successThreshold;
48  uint32_t m_timerTimeout;
49  uint8_t m_rate;
50  bool m_rtsOn;
51  uint32_t m_rtsWnd;
52  uint32_t m_rtsCounter;
54 };
55 
57 
58 TypeId
60 {
61  static TypeId tid = TypeId ("ns3::AarfcdWifiManager")
63  .SetGroupName ("Wifi")
64  .AddConstructor<AarfcdWifiManager> ()
65  .AddAttribute ("SuccessK", "Multiplication factor for the success threshold in the AARF algorithm.",
66  DoubleValue (2.0),
68  MakeDoubleChecker<double> ())
69  .AddAttribute ("TimerK",
70  "Multiplication factor for the timer threshold in the AARF algorithm.",
71  DoubleValue (2.0),
73  MakeDoubleChecker<double> ())
74  .AddAttribute ("MaxSuccessThreshold",
75  "Maximum value of the success threshold in the AARF algorithm.",
76  UintegerValue (60),
78  MakeUintegerChecker<uint32_t> ())
79  .AddAttribute ("MinTimerThreshold",
80  "The minimum value for the 'timer' threshold in the AARF algorithm.",
81  UintegerValue (15),
83  MakeUintegerChecker<uint32_t> ())
84  .AddAttribute ("MinSuccessThreshold",
85  "The minimum value for the success threshold in the AARF algorithm.",
86  UintegerValue (10),
88  MakeUintegerChecker<uint32_t> ())
89  .AddAttribute ("MinRtsWnd",
90  "Minimum value for Rts window of Aarf-CD",
91  UintegerValue (1),
93  MakeUintegerChecker<uint32_t> ())
94  .AddAttribute ("MaxRtsWnd",
95  "Maximum value for Rts window of Aarf-CD",
96  UintegerValue (40),
98  MakeUintegerChecker<uint32_t> ())
99  .AddAttribute ("TurnOffRtsAfterRateDecrease",
100  "If true the RTS mechanism will be turned off when the rate will be decreased",
101  BooleanValue (true),
104  .AddAttribute ("TurnOnRtsAfterRateIncrease",
105  "If true the RTS mechanism will be turned on when the rate will be increased",
106  BooleanValue (true),
109  .AddTraceSource ("Rate",
110  "Traced value for rate changes (b/s)",
112  "ns3::TracedValueCallback::Uint64")
113  ;
114  return tid;
115 }
116 
119  m_currentRate (0)
120 {
121  NS_LOG_FUNCTION (this);
122 }
123 
125 {
126  NS_LOG_FUNCTION (this);
127 }
128 
131 {
132  NS_LOG_FUNCTION (this);
134 
135  //aarf fields below
138  station->m_rate = 0;
139  station->m_success = 0;
140  station->m_failed = 0;
141  station->m_recovery = false;
142  station->m_retry = 0;
143  station->m_timer = 0;
144 
145  //aarf-cd specific fields below
146  station->m_rtsOn = false;
147  station->m_rtsWnd = m_minRtsWnd;
148  station->m_rtsCounter = 0;
149  station->m_justModifyRate = true;
150  station->m_haveASuccess = false;
151 
152  return station;
153 }
154 
155 void
157 {
158  NS_LOG_FUNCTION (this << station);
159 }
160 
161 void
163 {
164  NS_LOG_FUNCTION (this << st);
166  station->m_timer++;
167  station->m_failed++;
168  station->m_retry++;
169  station->m_success = 0;
170 
171  if (!station->m_rtsOn)
172  {
173  TurnOnRts (station);
174  if (!station->m_justModifyRate && !station->m_haveASuccess)
175  {
176  IncreaseRtsWnd (station);
177  }
178  else
179  {
180  ResetRtsWnd (station);
181  }
182  station->m_rtsCounter = station->m_rtsWnd;
183  if (station->m_retry >= 2)
184  {
185  station->m_timer = 0;
186  }
187  }
188  else if (station->m_recovery)
189  {
190  NS_ASSERT (station->m_retry >= 1);
191  station->m_justModifyRate = false;
192  station->m_rtsCounter = station->m_rtsWnd;
193  if (station->m_retry == 1)
194  {
195  //need recovery fallback
197  {
198  TurnOffRts (station);
199  }
200  station->m_justModifyRate = true;
201  station->m_successThreshold = (int)(Min (station->m_successThreshold * m_successK,
203  station->m_timerTimeout = (int)(Max (station->m_timerTimeout * m_timerK,
205  if (station->m_rate != 0)
206  {
207  station->m_rate--;
208  }
209  }
210  station->m_timer = 0;
211  }
212  else
213  {
214  NS_ASSERT (station->m_retry >= 1);
215  station->m_justModifyRate = false;
216  station->m_rtsCounter = station->m_rtsWnd;
217  if (((station->m_retry - 1) % 2) == 1)
218  {
219  //need normal fallback
221  {
222  TurnOffRts (station);
223  }
224  station->m_justModifyRate = true;
227  if (station->m_rate != 0)
228  {
229  station->m_rate--;
230  }
231  }
232  if (station->m_retry >= 2)
233  {
234  station->m_timer = 0;
235  }
236  }
237  CheckRts (station);
238 }
239 
240 void
242  double rxSnr, WifiMode txMode)
243 {
244  NS_LOG_FUNCTION (this << station << rxSnr << txMode);
245 }
246 
247 void
249  double ctsSnr, WifiMode ctsMode, double rtsSnr)
250 {
251  NS_LOG_FUNCTION (this << st << ctsSnr << ctsMode << rtsSnr);
253  NS_LOG_DEBUG ("station=" << station << " rts ok");
254  station->m_rtsCounter--;
255 }
256 
257 void
259  double ackSnr, WifiMode ackMode, double dataSnr)
260 {
261  NS_LOG_FUNCTION (this << st << ackSnr << ackMode << dataSnr);
263  station->m_timer++;
264  station->m_success++;
265  station->m_failed = 0;
266  station->m_recovery = false;
267  station->m_retry = 0;
268  station->m_justModifyRate = false;
269  station->m_haveASuccess = true;
270  NS_LOG_DEBUG ("station=" << station << " data ok success=" << station->m_success << ", timer=" << station->m_timer);
271  if ((station->m_success == station->m_successThreshold
272  || station->m_timer == station->m_timerTimeout)
273  && (station->m_rate < (GetNSupported (station) - 1)))
274  {
275  NS_LOG_DEBUG ("station=" << station << " inc rate");
276  station->m_rate++;
277  station->m_timer = 0;
278  station->m_success = 0;
279  station->m_recovery = true;
280  station->m_justModifyRate = true;
282  {
283  TurnOnRts (station);
284  ResetRtsWnd (station);
285  station->m_rtsCounter = station->m_rtsWnd;
286  }
287  }
288  CheckRts (station);
289 }
290 
291 void
293 {
294  NS_LOG_FUNCTION (this << station);
295 }
296 
297 void
299 {
300  NS_LOG_FUNCTION (this << station);
301 }
302 
305 {
306  NS_LOG_FUNCTION (this << st);
308  uint16_t channelWidth = GetChannelWidth (station);
309  if (channelWidth > 20 && channelWidth != 22)
310  {
311  //avoid to use legacy rate adaptation algorithms for IEEE 802.11n/ac
312  channelWidth = 20;
313  }
314  WifiMode mode = GetSupported (station, station->m_rate);
315  if (m_currentRate != mode.GetDataRate (channelWidth))
316  {
317  NS_LOG_DEBUG ("New datarate: " << mode.GetDataRate (channelWidth));
318  m_currentRate = mode.GetDataRate (channelWidth);
319  }
320  return WifiTxVector (mode, GetDefaultTxPowerLevel (), GetPreambleForTransmission (mode, GetAddress (station)), 800, 1, 1, 0, channelWidth, GetAggregation (station), false);
321 }
322 
325 {
326  NS_LOG_FUNCTION (this << st);
330  uint16_t channelWidth = GetChannelWidth (station);
331  if (channelWidth > 20 && channelWidth != 22)
332  {
333  //avoid to use legacy rate adaptation algorithms for IEEE 802.11n/ac
334  channelWidth = 20;
335  }
336  WifiTxVector rtsTxVector;
337  WifiMode mode;
338  if (GetUseNonErpProtection () == false)
339  {
340  mode = GetSupported (station, 0);
341  }
342  else
343  {
344  mode = GetNonErpSupported (station, 0);
345  }
346  rtsTxVector = WifiTxVector (mode, GetDefaultTxPowerLevel (), GetPreambleForTransmission (mode, GetAddress (station)), 800, 1, 1, 0, channelWidth, GetAggregation (station), false);
347  return rtsTxVector;
348 }
349 
350 bool
352  Ptr<const Packet> packet, bool normally)
353 {
354  NS_LOG_FUNCTION (this << st << packet << normally);
356  NS_LOG_INFO ("" << station << " rate=" << station->m_rate << " rts=" << (station->m_rtsOn ? "RTS" : "BASIC") <<
357  " rtsCounter=" << station->m_rtsCounter);
358  return station->m_rtsOn;
359 }
360 
361 bool
363 {
364  return true;
365 }
366 
367 void
369 {
370  NS_LOG_FUNCTION (this << station);
371  if (station->m_rtsCounter == 0 && station->m_rtsOn)
372  {
373  TurnOffRts (station);
374  }
375 }
376 
377 void
379 {
380  NS_LOG_FUNCTION (this << station);
381  station->m_rtsOn = false;
382  station->m_haveASuccess = false;
383 }
384 
385 void
387 {
388  NS_LOG_FUNCTION (this << station);
389  station->m_rtsOn = true;
390 }
391 
392 void
394 {
395  NS_LOG_FUNCTION (this << station);
396  if (station->m_rtsWnd == m_maxRtsWnd)
397  {
398  return;
399  }
400 
401  station->m_rtsWnd *= 2;
402  if (station->m_rtsWnd > m_maxRtsWnd)
403  {
404  station->m_rtsWnd = m_maxRtsWnd;
405  }
406 }
407 
408 void
410 {
411  NS_LOG_FUNCTION (this << station);
412  station->m_rtsWnd = m_minRtsWnd;
413 }
414 
415 void
417 {
418  //HT is not supported by this algorithm.
419  if (enable)
420  {
421  NS_FATAL_ERROR ("WifiRemoteStationManager selected does not support HT rates");
422  }
423 }
424 
425 void
427 {
428  //VHT is not supported by this algorithm.
429  if (enable)
430  {
431  NS_FATAL_ERROR ("WifiRemoteStationManager selected does not support VHT rates");
432  }
433 }
434 
435 void
437 {
438  //HE is not supported by this algorithm.
439  if (enable)
440  {
441  NS_FATAL_ERROR ("WifiRemoteStationManager selected does not support HE rates");
442  }
443 }
444 
445 } //namespace ns3
void DoReportDataFailed(WifiRemoteStation *station)
It is important to realize that "recovery" mode starts after failure of the first transmission after ...
uint32_t m_successThreshold
success threshold
#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
WifiTxVector DoGetDataTxVector(WifiRemoteStation *station)
AttributeValue implementation for Boolean.
Definition: boolean.h:36
double m_timerK
Multiplication factor for the timer threshold.
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
bool DoNeedRts(WifiRemoteStation *station, Ptr< const Packet > packet, bool normally)
bool m_justModifyRate
just modify rate
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:45
uint32_t m_rtsCounter
RTS counter.
bool m_haveASuccess
have a success
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
uint32_t m_maxSuccessThreshold
maximum success threshold
#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 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_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition: log.h:278
#define NS_FATAL_ERROR(msg)
Report a fatal error with a message and terminate.
Definition: fatal-error.h:162
uint32_t m_maxRtsWnd
maximum RTS window
uint32_t m_minRtsWnd
minimum RTS window
bool m_turnOnRtsAfterRateIncrease
turn on RTS after rate increase
void SetHeSupported(bool enable)
Enable or disable HE capability support.
represent a single transmission modeA WifiMode is implemented by a single integer which is used to lo...
Definition: wifi-mode.h:97
void DoReportFinalDataFailed(WifiRemoteStation *station)
This method is a pure virtual method that must be implemented by the sub-class.
bool GetAggregation(const WifiRemoteStation *station) const
Return whether the given station supports A-MPDU.
Ptr< const TraceSourceAccessor > MakeTraceSourceAccessor(T a)
Create a TraceSourceAccessor which will control access to the underlying trace source.
void DoReportFinalRtsFailed(WifiRemoteStation *station)
This method is a pure virtual method that must be implemented by the sub-class.
void TurnOnRts(AarfcdWifiRemoteStation *station)
Turn on RTS for the given station.
void TurnOffRts(AarfcdWifiRemoteStation *station)
Turn off RTS for the given station.
int64x64_t Min(const int64x64_t &a, const int64x64_t &b)
Minimum.
Definition: int64x64.h:197
Hold an unsigned integer type.
Definition: uinteger.h:44
WifiPreamble GetPreambleForTransmission(WifiMode mode, Mac48Address dest)
Return the preamble to be used for the transmission.
int64x64_t Max(const int64x64_t &a, const int64x64_t &b)
Maximum.
Definition: int64x64.h:209
TracedValue< uint64_t > m_currentRate
Trace rate changes.
void ResetRtsWnd(AarfcdWifiRemoteStation *station)
Reset the RTS window of the given station.
Mac48Address GetAddress(const WifiRemoteStation *station) const
Return the address of the station.
hold a list of per-remote-station state.
void CheckRts(AarfcdWifiRemoteStation *station)
Check if the use of RTS for the given station can be turned off.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Ptr< const AttributeChecker > MakeBooleanChecker(void)
Definition: boolean.cc:121
bool IsLowLatency(void) const
void SetVhtSupported(bool enable)
Enable or disable VHT capability support.
void DoReportRtsFailed(WifiRemoteStation *station)
This method is a pure virtual method that must be implemented by the sub-class.
uint32_t m_minSuccessThreshold
minimum success threshold
WifiMode GetSupported(const WifiRemoteStation *station, uint8_t i) const
Return whether mode associated with the specified station at the specified index. ...
WifiRemoteStation * DoCreateStation(void) const
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
hold per-remote-station state for AARF-CD Wifi manager.
WifiMode GetNonErpSupported(const WifiRemoteStation *station, uint8_t i) const
Return whether non-ERP mode associated with the specified station at the specified index...
void SetHtSupported(bool enable)
Enable or disable HT capability support.
uint32_t m_minTimerThreshold
minimum timer threshold
bool m_turnOffRtsAfterRateDecrease
turn off RTS after rate decrease
double m_successK
Multiplication factor for the success threshold.
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
Definition: log.h:270
uint8_t GetNSupported(const WifiRemoteStation *station) const
Return the number of modes supported by the given station.
static TypeId GetTypeId(void)
Get the type ID.
an implementation of the AARF-CD algorithmThis algorithm was first described in "Efficient Collision ...
void DoReportRxOk(WifiRemoteStation *station, double rxSnr, WifiMode txMode)
This method is a pure virtual method that must be implemented by the sub-class.
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.
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
void IncreaseRtsWnd(AarfcdWifiRemoteStation *station)
Increase the RTS window size of the given station.
uint32_t m_timerTimeout
timer timeout
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.
WifiTxVector DoGetRtsTxVector(WifiRemoteStation *station)
uint16_t GetChannelWidth(const WifiRemoteStation *station) const
Return the channel width supported by the station.