A Discrete-Event Network Simulator
API
minstrel-ht-wifi-manager.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2009 Duy Nguyen
4  * Copyright (c) 2015 Ghada Badawy
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 as
8  * published by the Free Software Foundation;
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  *
19  *Authors: Duy Nguyen <duy@soe.ucsc.edu>
20  * Ghada Badawy <gbadawy@gmail.com>
21  * Matias Richart <mrichart@fing.edu.uy>
22  *
23  * MinstrelHt is a rate adaptation algorithm for high-throughput (HT) 802.11
24  */
25 
26 #ifndef MINSTREL_HT_WIFI_MANAGER_H
27 #define MINSTREL_HT_WIFI_MANAGER_H
28 
29 #include "ns3/wifi-remote-station-manager.h"
30 #include "minstrel-wifi-manager.h"
31 #include "ns3/wifi-mpdu-type.h"
32 
33 namespace ns3 {
34 
38 typedef std::map<WifiMode, Time> TxTime;
39 
46 struct McsGroup
47 {
48  uint8_t streams;
49  uint8_t sgi;
50  uint16_t chWidth;
51  bool isVht;
52  bool isSupported;
53  // To accurately account for TX times, we separate the TX time of the first
54  // MPDU in an A-MPDU from the rest of the MPDUs.
57 };
58 
63 typedef std::vector<McsGroup> MinstrelMcsGroups;
64 
69 struct HtRateInfo
70 {
76  bool supported;
77  uint8_t mcsIndex;
78  uint32_t retryCount;
79  uint32_t adjustedRetryCount;
80  uint32_t numRateAttempt;
81  uint32_t numRateSuccess;
82  double prob;
83  bool retryUpdated;
84 
89  double ewmaProb;
90  double ewmsdProb;
91  uint32_t prevNumRateAttempt;
92  uint32_t prevNumRateSuccess;
93  uint32_t numSamplesSkipped;
94  uint64_t successHist;
95  uint64_t attemptHist;
96  double throughput;
97 };
98 
103 typedef std::vector<HtRateInfo> HtMinstrelRate;
104 
108 struct GroupInfo
109 {
113  uint8_t m_col;
114  uint8_t m_index;
115  bool m_supported;
116  uint16_t m_maxTpRate;
117  uint16_t m_maxTpRate2;
118  uint16_t m_maxProbRate;
120 };
121 
126 typedef std::vector<struct GroupInfo> McsGroupData;
127 
132 static const uint8_t MAX_SUPPORTED_STREAMS = 4;
133 static const uint8_t MAX_HT_STREAM_GROUPS = 4;
134 static const uint8_t MAX_VHT_STREAM_GROUPS = 8;
135 static const uint8_t MAX_HT_GROUP_RATES = 8;
136 static const uint8_t MAX_VHT_GROUP_RATES = 10;
137 static const uint8_t MAX_HT_WIDTH = 40;
138 static const uint8_t MAX_VHT_WIDTH = 160;
139 
189 {
190 public:
195  static TypeId GetTypeId (void);
197  virtual ~MinstrelHtWifiManager ();
198 
207  int64_t AssignStreams (int64_t stream);
208 
209  // Inherited from WifiRemoteStationManager
210  void SetupPhy (const Ptr<WifiPhy> phy);
211  void SetupMac (const Ptr<WifiMac> mac);
212 
219  typedef void (*RateChangeTracedCallback)(const uint64_t rate, const Mac48Address remoteAddress);
220 
221 
222 private:
223  // Overridden from base class.
224  void DoInitialize (void);
225  WifiRemoteStation * DoCreateStation (void) const;
226  void DoReportRxOk (WifiRemoteStation *station,
227  double rxSnr, WifiMode txMode);
228  void DoReportRtsFailed (WifiRemoteStation *station);
229  void DoReportDataFailed (WifiRemoteStation *station);
230  void DoReportRtsOk (WifiRemoteStation *station,
231  double ctsSnr, WifiMode ctsMode, double rtsSnr);
232  void DoReportDataOk (WifiRemoteStation *station, double ackSnr, WifiMode ackMode,
233  double dataSnr, uint16_t dataChannelWidth, uint8_t dataNss);
238  void DoReportAmpduTxStatus (WifiRemoteStation *station, uint16_t nSuccessfulMpdus, uint16_t nFailedMpdus,
239  double rxSnr, double dataSnr, uint16_t dataChannelWidth, uint8_t dataNss);
240  bool DoNeedRetransmission (WifiRemoteStation *st, Ptr<const Packet> packet, bool normally);
241 
251  bool IsValidMcs (Ptr<WifiPhy> phy, uint8_t streams, uint16_t chWidth, WifiMode mode);
252 
264  Time CalculateMpduTxDuration (Ptr<WifiPhy> phy, uint8_t streams, uint8_t sgi,
265  uint16_t chWidth, WifiMode mode, MpduType mpduType);
266 
274  Time GetMpduTxTime (uint8_t groupId, WifiMode mode) const;
275 
283  void AddMpduTxTime (uint8_t groupId, WifiMode mode, Time t);
284 
292  Time GetFirstMpduTxTime (uint8_t groupId, WifiMode mode) const;
293 
301  void AddFirstMpduTxTime (uint8_t groupId, WifiMode mode, Time t);
302 
308 
316  void UpdatePacketCounters (MinstrelHtWifiRemoteStation *station, uint16_t nSuccessfulMpdus, uint16_t nFailedMpdus);
317 
324  uint16_t GetNextSample (MinstrelHtWifiRemoteStation *station);
325 
332 
339  uint16_t FindRate (MinstrelHtWifiRemoteStation *station);
340 
347 
353  void RateInit (MinstrelHtWifiRemoteStation *station);
354 
364  double CalculateThroughput (MinstrelHtWifiRemoteStation *station, uint8_t groupId, uint8_t rateId, double ewmaProb);
365 
372  void SetBestStationThRates (MinstrelHtWifiRemoteStation *station, uint16_t index);
373 
380  void SetBestProbabilityRate (MinstrelHtWifiRemoteStation *station, uint16_t index);
381 
388  void CalculateRetransmits (MinstrelHtWifiRemoteStation *station, uint16_t index);
389 
397  void CalculateRetransmits (MinstrelHtWifiRemoteStation *station, uint8_t groupId, uint8_t rateId);
398 
420  Time CalculateTimeUnicastPacket (Time dataTransmissionTime, uint32_t shortRetries, uint32_t longRetries);
421 
431  double CalculateEwmsd (double oldEwmsd, double currentProb, double ewmaProb, double weight);
432 
439 
446 
452  void PrintTable (MinstrelHtWifiRemoteStation *station);
453 
461  void StatsDump (MinstrelHtWifiRemoteStation *station, uint8_t groupId, std::ofstream &of);
462 
468  void CheckInit (MinstrelHtWifiRemoteStation *station);
469 
476  uint32_t CountRetries (MinstrelHtWifiRemoteStation * station);
477 
483  void UpdateRate (MinstrelHtWifiRemoteStation *station);
484 
502  uint8_t GetRateId (uint16_t index);
503 
510  uint8_t GetGroupId (uint16_t index);
511 
519  uint16_t GetIndex (uint8_t groupId, uint8_t rateId);
520 
529  uint8_t GetHtGroupId (uint8_t txstreams, uint8_t sgi, uint16_t chWidth);
530 
539  uint8_t GetVhtGroupId (uint8_t txstreams, uint8_t sgi, uint16_t chWidth);
540 
547  uint16_t GetLowestIndex (MinstrelHtWifiRemoteStation *station);
548 
556  uint16_t GetLowestIndex (MinstrelHtWifiRemoteStation *station, uint8_t groupId);
557 
562  WifiModeList GetVhtDeviceMcsList (void) const;
563 
568  WifiModeList GetHtDeviceMcsList (void) const;
569 
573  uint8_t m_ewmaLevel;
574  uint8_t m_nSampleCol;
575  uint32_t m_frameLength;
576  uint8_t m_numGroups;
577  uint8_t m_numRates;
580 
582 
584 
586 
588 };
589 
590 } // namespace ns3
591 
592 #endif /* MINSTREL_HT_WIFI_MANAGER_H */
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.
uint16_t m_maxProbRate
The highest success probability rate of this group in bps.
uint8_t m_nSampleCol
Number of sample columns.
double throughput
Throughput of this rate (in packets per second).
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:103
bool m_supported
If the rates of this group are supported by the station.
Time GetMpduTxTime(uint8_t groupId, WifiMode mode) const
Obtain the TxTime saved in the group information.
A struct to contain information of a group.
WifiModeList GetVhtDeviceMcsList(void) const
Returns a list of only the VHT MCS supported by the device.
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
static const uint8_t MAX_SUPPORTED_STREAMS
Constants for maximum values.
TracedValue< uint64_t > m_currentRate
Trace rate changes.
void PrintTable(MinstrelHtWifiRemoteStation *station)
Printing Minstrel Table.
uint16_t GetLowestIndex(MinstrelHtWifiRemoteStation *station)
Returns the lowest global index of the rates supported by the station.
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...
uint8_t m_col
MCS rates are divided into groups based on the number of streams and flags that they use...
void SetBestProbabilityRate(MinstrelHtWifiRemoteStation *station, uint16_t index)
Set index rate as maxProbRate if it is better than current value.
MinstrelHtWifiRemoteStation structure.
WifiTxVector DoGetDataTxVector(WifiRemoteStation *station)
void CalculateRetransmits(MinstrelHtWifiRemoteStation *station, uint16_t index)
Calculate the number of retransmissions to set for the index rate.
static const uint8_t MAX_VHT_STREAM_GROUPS
Maximal number of groups per stream in VHT (4 possible channel widths and 2 possible SGI configuratio...
bool isSupported
is supported?
WifiRemoteStation * DoCreateStation(void) const
double prob
Current probability within last time interval.
void DoReportFinalRtsFailed(WifiRemoteStation *station)
This method is a pure virtual method that must be implemented by the sub-class.
Time m_legacyUpdateStats
How frequent do we calculate the stats for legacy MinstrelWifiManager.
HtMinstrelRate m_ratesTable
Information about rates of this group.
uint8_t sgi
short guard interval (0 or 1)
uint16_t FindRate(MinstrelHtWifiRemoteStation *station)
Find a rate to use from Minstrel Table.
void DoReportRxOk(WifiRemoteStation *station, double rxSnr, WifiMode txMode)
This method is a pure virtual method that must be implemented by the sub-class.
uint32_t m_frameLength
Frame length used for calculate modes TxTime in bytes.
MinstrelMcsGroups m_minstrelGroups
Global array for groups information.
STL namespace.
Time CalculateTimeUnicastPacket(Time dataTransmissionTime, uint32_t shortRetries, uint32_t longRetries)
Estimate the time to transmit the given packet with the given number of retries.
represent a single transmission modeA WifiMode is implemented by a single integer which is used to lo...
Definition: wifi-mode.h:68
TxTime ratesFirstMpduTxTimeTable
rates MPDU transmit time table
bool DoNeedRetransmission(WifiRemoteStation *st, Ptr< const Packet > packet, bool normally)
uint8_t GetRateId(uint16_t index)
For managing rates from different groups, a global index for all rates in all groups is used...
bool m_printStats
If statistics table should be printed.
MpduType
The type of an MPDU.
uint32_t adjustedRetryCount
Adjust the retry limit for this rate.
uint16_t GetIndex(uint8_t groupId, uint8_t rateId)
Returns the global index corresponding to the groupId and rateId.
uint32_t numRateAttempt
Number of transmission attempts so far.
uint8_t m_index
Sample table index.
uint8_t m_lookAroundRate
The % to try other rates than our current rate.
phy
Definition: third.py:93
uint8_t m_ewmaLevel
Exponential weighted moving average level (or coefficient).
void SetBestStationThRates(MinstrelHtWifiRemoteStation *station, uint16_t index)
Set index rate as maxTpRate or maxTp2Rate if is better than current values.
Time GetFirstMpduTxTime(uint8_t groupId, WifiMode mode) const
Obtain the TxTime saved in the group information.
TxTime ratesTxTimeTable
rates transmit time table
uint16_t chWidth
channel width (MHz)
WifiTxVector DoGetRtsTxVector(WifiRemoteStation *station)
void DoReportDataOk(WifiRemoteStation *station, double ackSnr, WifiMode ackMode, double dataSnr, uint16_t dataChannelWidth, uint8_t dataNss)
This method is a pure virtual method that must be implemented by the sub-class.
static const uint8_t MAX_VHT_GROUP_RATES
Number of rates (or MCS) per VHT group.
static const uint8_t MAX_HT_WIDTH
Maximal channel width in MHz.
mac
Definition: third.py:99
uint8_t streams
streams
static const uint8_t MAX_HT_STREAM_GROUPS
Maximal number of groups per stream in HT (2 possible channel widths and 2 possible SGI configuration...
uint8_t mcsIndex
The index in the operationalMcsSet of the WifiRemoteStationManager.
Ptr< UniformRandomVariable > m_uniformRandomVariable
Provides uniform random variables.
hold a list of per-remote-station state.
bool m_useVhtOnly
If only VHT MCS should be used, instead of HT and VHT.
std::vector< struct GroupInfo > McsGroupData
Data structure for a table of groups.
static TypeId GetTypeId(void)
Get the type ID.
static const uint8_t MAX_VHT_WIDTH
Maximal channel width in MHz.
int64_t AssignStreams(int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model...
bool retryUpdated
If number of retries was updated already.
uint16_t GetNextSample(MinstrelHtWifiRemoteStation *station)
Getting the next sample from Sample Table.
uint16_t m_maxTpRate2
The second max throughput rate of this group in bps.
double ewmaProb
Exponential weighted moving average of probability.
Time perfectTxTime
Perfect transmission time calculation, or frame calculation.
bool IsValidMcs(Ptr< WifiPhy > phy, uint8_t streams, uint16_t chWidth, WifiMode mode)
Check the validity of a combination of number of streams, chWidth and mode.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
uint8_t m_numRates
Number of rates per group Minstrel should consider.
void DoReportAmpduTxStatus(WifiRemoteStation *station, uint16_t nSuccessfulMpdus, uint16_t nFailedMpdus, double rxSnr, double dataSnr, uint16_t dataChannelWidth, uint8_t dataNss)
Typically called per A-MPDU, either when a Block ACK was successfully received or when a BlockAckTime...
void InitSampleTable(MinstrelHtWifiRemoteStation *station)
Initialize Sample Table.
double CalculateThroughput(MinstrelHtWifiRemoteStation *station, uint8_t groupId, uint8_t rateId, double ewmaProb)
Return the average throughput of the MCS defined by groupId and rateId.
void DoReportRtsFailed(WifiRemoteStation *station)
This method is a pure virtual method that must be implemented by the sub-class.
void UpdateRetry(MinstrelHtWifiRemoteStation *station)
Update the number of retries and reset accordingly.
void DoReportFinalDataFailed(WifiRemoteStation *station)
This method is a pure virtual method that must be implemented by the sub-class.
bool supported
If the rate is supported.
uint8_t m_numGroups
Number of groups Minstrel should consider.
Time m_updateStats
How frequent do we calculate the stats.
an EUI-48 address
Definition: mac48-address.h:43
static const uint8_t MAX_HT_GROUP_RATES
Number of rates (or MCS) per HT group.
void DoReportDataFailed(WifiRemoteStation *station)
This method is a pure virtual method that must be implemented by the sub-class.
void UpdateStats(MinstrelHtWifiRemoteStation *station)
Update the Minstrel Table.
uint32_t prevNumRateAttempt
Number of transmission attempts with previous rate.
std::vector< WifiMode > WifiModeList
In various parts of the code, folk are interested in maintaining a list of transmission modes...
Definition: wifi-mode.h:255
uint16_t m_maxTpRate
The max throughput rate of this group in bps.
std::vector< HtRateInfo > HtMinstrelRate
Data structure for a Minstrel Rate table.
void RateInit(MinstrelHtWifiRemoteStation *station)
Initialize Minstrel Table.
Implementation of Minstrel HT Rate Control AlgorithmMinstrel-HT is a rate adaptation mechanism for th...
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...
Data structure to contain the information that defines a group.
uint32_t retryCount
Retry limit.
double ewmsdProb
Exponential weighted moving standard deviation of probability.
void DoInitialize(void)
Initialize() implementation.
void StatsDump(MinstrelHtWifiRemoteStation *station, uint8_t groupId, std::ofstream &of)
Print group statistics.
void UpdatePacketCounters(MinstrelHtWifiRemoteStation *station, uint16_t nSuccessfulMpdus, uint16_t nFailedMpdus)
Update the number of sample count variables.
std::map< WifiMode, Time > TxTime
Data structure to save transmission time calculations per rate.
uint8_t GetVhtGroupId(uint8_t txstreams, uint8_t sgi, uint16_t chWidth)
Returns the groupId of a VHT MCS with the given number of streams, if using SGI and the channel width...
double CalculateEwmsd(double oldEwmsd, double currentProb, double ewmaProb, double weight)
Perform EWMSD (Exponentially Weighted Moving Standard Deviation) calculation.
void(* RateChangeTracedCallback)(const uint64_t rate, const Mac48Address remoteAddress)
TracedCallback signature for rate change events.
uint32_t numRateSuccess
Number of successful frames transmitted so far.
std::vector< McsGroup > MinstrelMcsGroups
Data structure for a table of group definitions.
void AddMpduTxTime(uint8_t groupId, WifiMode mode, Time t)
Save a TxTime to the vector of groups.
A struct to contain all statistics information related to a data rate.
void SetNextSample(MinstrelHtWifiRemoteStation *station)
Set the next sample from Sample Table.
void PrintSampleTable(MinstrelHtWifiRemoteStation *station)
Printing Sample Table.
WifiModeList GetHtDeviceMcsList(void) const
Returns a list of only the HT MCS supported by the device.
Ptr< MinstrelWifiManager > m_legacyManager
Pointer to an instance of MinstrelWifiManager.
uint32_t numSamplesSkipped
Number of times this rate statistics were not updated because no attempts have been made...
uint64_t successHist
Aggregate of all transmission successes.
uint32_t prevNumRateSuccess
Number of successful frames transmitted with previous rate.
uint64_t attemptHist
Aggregate of all transmission attempts.
uint8_t GetHtGroupId(uint8_t txstreams, uint8_t sgi, uint16_t chWidth)
Returns the groupId of a HT MCS with the given number of streams, if using SGI and the channel width ...
uint8_t GetGroupId(uint16_t index)
Return the groupId from the global index.
Time CalculateMpduTxDuration(Ptr< WifiPhy > phy, uint8_t streams, uint8_t sgi, uint16_t chWidth, WifiMode mode, MpduType mpduType)
Estimates the TxTime of a frame with a given mode and group (stream, guard interval and channel width...
uint32_t CountRetries(MinstrelHtWifiRemoteStation *station)
Count retries.
void UpdateRate(MinstrelHtWifiRemoteStation *station)
Update rate.
void AddFirstMpduTxTime(uint8_t groupId, WifiMode mode, Time t)
Save a TxTime to the vector of groups.
a unique identifier for an interface.
Definition: type-id.h:58
void CheckInit(MinstrelHtWifiRemoteStation *station)
Check for initializations.
hold per-remote-station state.