23#include "ns3/packet.h"
24#include "ns3/random-variable-stream.h"
25#include "ns3/simulator.h"
26#include "ns3/wifi-mac.h"
27#include "ns3/wifi-phy.h"
31#define Min(a, b) ((a < b) ? a : b)
44 TypeId(
"ns3::MinstrelWifiManager")
48 .AddAttribute(
"UpdateStatistics",
49 "The interval between updating statistics table",
53 .AddAttribute(
"LookAroundRate",
54 "The percentage to try other rates",
63 .AddAttribute(
"SampleColumn",
64 "The number of columns used for sampling",
68 .AddAttribute(
"PacketLength",
69 "The packet length used for calculating mode TxTime",
73 .AddAttribute(
"PrintStats",
74 "Print statistics table",
78 .AddAttribute(
"PrintSamples",
79 "Print samples table",
83 .AddTraceSource(
"Rate",
84 "Traced value for rate changes (b/s)",
86 "ns3::TracedValueCallback::Uint64");
107 for (
const auto& mode : phy->GetModeList())
130 NS_FATAL_ERROR(
"WifiRemoteStationManager selected does not support HT rates");
134 NS_FATAL_ERROR(
"WifiRemoteStationManager selected does not support VHT rates");
138 NS_FATAL_ERROR(
"WifiRemoteStationManager selected does not support HE rates");
174 station->m_index = 0;
175 station->m_maxTpRate = 0;
176 station->m_maxTpRate2 = 0;
177 station->m_maxProbRate = 0;
178 station->m_nModes = 0;
179 station->m_totalPacketsCount = 0;
180 station->m_samplePacketsCount = 0;
181 station->m_isSampling =
false;
182 station->m_sampleRate = 0;
183 station->m_sampleDeferred =
false;
184 station->m_shortRetry = 0;
185 station->m_longRetry = 0;
186 station->m_retry = 0;
187 station->m_txrate = 0;
188 station->m_initialized =
false;
247 NS_LOG_DEBUG(
" More retries left for the maximum throughput rate.");
256 NS_LOG_DEBUG(
" More retries left for the second maximum throughput rate.");
266 NS_LOG_DEBUG(
" More retries left for the maximum probability rate.");
291 NS_LOG_DEBUG(
"Look around rate is slower than the maximum throughput rate.");
296 NS_LOG_DEBUG(
" More retries left for the maximum throughput rate.");
305 NS_LOG_DEBUG(
" More retries left for the sampling rate.");
315 NS_LOG_DEBUG(
" More retries left for the maximum probability rate.");
332 NS_LOG_DEBUG(
"Look around rate is faster than the maximum throughput rate.");
337 NS_LOG_DEBUG(
" More retries left for the sampling rate.");
346 NS_LOG_DEBUG(
" More retries left for the maximum throughput rate.");
356 NS_LOG_DEBUG(
" More retries left for the maximum probability rate.");
378 if (channelWidth > 20 && channelWidth != 22)
411 if (channelWidth > 20 && channelWidth != 22)
479 uint8_t ratesSupported = station->
m_nModes;
480 if (delta > ratesSupported * 2)
547 NS_LOG_DEBUG(
"The next look around rate is slower than the maximum throughput rate, "
548 "continue with the maximum throughput rate: "
557 NS_LOG_DEBUG(
"Continue using the maximum throughput rate: "
591 for (uint8_t i = 0; i < station->
m_nModes; i++)
687 uint8_t index_max_tp = 0;
688 uint8_t index_max_tp2 = 0;
692 "Finding the maximum throughput, second maximum throughput, and highest probability");
694 for (uint8_t i = 0; i < station->
m_nModes; i++)
700 if (max_tp < station->m_minstrelTable[i].
throughput)
709 for (uint8_t i = 0; i < station->
m_nModes; i++)
711 if ((i != index_max_tp) && (max_tp < station->m_minstrelTable[i].
throughput))
719 uint8_t index_max_prob = 0;
720 for (uint8_t i = 0; i < station->
m_nModes; i++)
736 if (index_max_tp > station->
m_txrate)
742 <<
")\tsecond max throughput=" << +index_max_tp2 <<
"("
744 <<
")\tmax prob=" << +index_max_prob <<
"("
768 NS_LOG_DEBUG(
"DoReportRtsFailed m_txrate=" << station->m_txrate);
769 station->m_shortRetry++;
794 NS_LOG_DEBUG(
"DoReportDataFailed " << station <<
"\t rate " << station->m_txrate
795 <<
"\tlongRetry \t" << station->m_longRetry);
797 if (!station->m_initialized)
810 MHz_u dataChannelWidth,
813 NS_LOG_FUNCTION(
this << st << ackSnr << ackMode << dataSnr << dataChannelWidth << +dataNss);
817 if (!station->m_initialized)
824 <<
", attempt = " << station->m_minstrelTable[station->m_txrate].numRateAttempt
825 <<
", success = " << station->m_minstrelTable[station->m_txrate].numRateSuccess
826 <<
" (before update).");
828 station->m_minstrelTable[station->m_txrate].numRateSuccess++;
829 station->m_minstrelTable[station->m_txrate].numRateAttempt++;
835 <<
", attempt = " << station->m_minstrelTable[station->m_txrate].numRateAttempt
836 <<
", success = " << station->m_minstrelTable[station->m_txrate].numRateSuccess
837 <<
" (after update).");
842 if (station->m_nModes >= 1)
844 station->m_txrate =
FindRate(station);
846 NS_LOG_DEBUG(
"Next rate to use TxRate = " << station->m_txrate);
856 if (!station->m_initialized)
863 <<
", attempt = " << station->m_minstrelTable[station->m_txrate].numRateAttempt
864 <<
", success = " << station->m_minstrelTable[station->m_txrate].numRateSuccess
865 <<
" (before update).");
874 <<
", attempt = " << station->m_minstrelTable[station->m_txrate].numRateAttempt
875 <<
", success = " << station->m_minstrelTable[station->m_txrate].numRateSuccess
876 <<
" (after update).");
878 if (station->m_nModes >= 1)
880 station->m_txrate =
FindRate(station);
882 NS_LOG_DEBUG(
"Next rate to use TxRate = " << station->m_txrate);
948 if (!station->m_initialized)
955 << station->m_longRetry <<
" Max retries: " <<
CountRetries(station));
960 NS_LOG_DEBUG(
"Re-transmit. Retries: " << station->m_longRetry
992 for (uint8_t i = 0; i < station->
m_nModes; i++)
1014 for (
uint32_t retries = 2; retries < 11; retries++)
1017 totalTxTimeWithGivenRetries =
1019 NS_LOG_DEBUG(
" totalTxTimeWithGivenRetries = " << totalTxTimeWithGivenRetries);
1037 NS_LOG_FUNCTION(
this << dataTransmissionTime << shortRetries << longRetries);
1045 for (
uint32_t retry = 0; retry < longRetries; retry++)
1054 cw = std::min(cwMax, (cw + 1) * 2);
1067 uint8_t numSampleRates = station->
m_nModes;
1072 for (uint8_t i = 0; i < numSampleRates; i++)
1080 newIndex = (i + uv) % numSampleRates;
1085 newIndex = (newIndex + 1) % station->
m_nModes;
1095 uint8_t numSampleRates = station->
m_nModes;
1096 std::stringstream table;
1097 for (uint8_t i = 0; i < numSampleRates; i++)
1113 std::ostringstream tmp;
1115 station->
m_statsFile.open(tmp.str(), std::ios::out);
1119 <<
"best _______________rate________________ ________statistics________ "
1120 "________last_______ ______sum-of________\n"
1121 <<
"rate [ name idx airtime max_tp] [avg(tp) avg(prob) sd(prob)] "
1122 "[prob.|retry|suc|att] [#success | #attempts]\n";
1128 for (uint8_t i = 0; i < station->
m_nModes; i++)
1140 if (i == maxTpRate2)
1148 if (i == maxProbRate)
1159 << std::setw(2) << i <<
" " << std::setw(4)
1161 <<
" ----- " << std::setw(8) << tmpTh <<
" " << std::setw(3)
1162 << rate.
ewmaProb / 180 << std::setw(3) <<
" --- "
1163 << std::setw(3) << rate.
prob / 180 <<
" " << std::setw(1)
1167 <<
" " << std::setw(9) << rate.
attemptHist <<
"\n";
1169 station->
m_statsFile <<
"\nTotal packet count: ideal "
Implementation of Minstrel Rate Control Algorithm.
WifiRemoteStation * DoCreateStation() const override
WifiTxVector DoGetRtsTxVector(WifiRemoteStation *station) override
WifiTxVector DoGetDataTxVector(WifiRemoteStation *station, MHz_u allowedWidth) override
~MinstrelWifiManager() override
uint8_t m_lookAroundRate
the % to try other rates than our current rate
void DoReportDataOk(WifiRemoteStation *station, double ackSnr, WifiMode ackMode, double dataSnr, MHz_u dataChannelWidth, uint8_t dataNss) override
This method is a pure virtual method that must be implemented by the sub-class.
void PrintSampleTable(MinstrelWifiRemoteStation *station) const
Print Sample Table.
void AddCalcTxTime(WifiMode mode, Time t)
Add transmission time for the given mode to an internal list.
void RateInit(MinstrelWifiRemoteStation *station)
Initialize Minstrel Table.
uint32_t m_pktLen
packet length used to calculate mode TxTime
void DoReportFinalDataFailed(WifiRemoteStation *station) override
This method is a pure virtual method that must be implemented by the sub-class.
void DoInitialize() override
Initialize() implementation.
void UpdateStats(MinstrelWifiRemoteStation *station)
Update the Minstrel Table.
void CheckInit(MinstrelWifiRemoteStation *station)
Check for initializations.
static TypeId GetTypeId()
Get the type ID.
Ptr< UniformRandomVariable > m_uniformRandomVariable
Provides uniform random variables.
TxTime m_calcTxTime
to hold all the calculated TxTime for all modes
bool m_printSamples
whether samples table should be printed.
void DoReportDataFailed(WifiRemoteStation *station) override
This method is a pure virtual method that must be implemented by the sub-class.
bool m_printStats
whether statistics table should be printed.
WifiTxVector GetRtsTxVector(MinstrelWifiRemoteStation *station)
Get RTS transmit vector.
uint8_t m_sampleCol
number of sample columns
void DoReportFinalRtsFailed(WifiRemoteStation *station) override
This method is a pure virtual method that must be implemented by the sub-class.
void SetupMac(const Ptr< WifiMac > mac) override
Set up MAC associated with this device since it is the object that knows the full set of timing param...
uint16_t FindRate(MinstrelWifiRemoteStation *station)
Find a rate to use from Minstrel Table.
Time GetCalcTxTime(WifiMode mode) const
Estimate the TxTime of a packet with a given mode.
Time CalculateTimeUnicastPacket(Time dataTransmissionTime, uint32_t shortRetries, uint32_t longRetries)
Estimate the time to transmit the given packet with the given number of retries.
void DoReportRtsOk(WifiRemoteStation *station, double ctsSnr, WifiMode ctsMode, double rtsSnr) override
This method is a pure virtual method that must be implemented by the sub-class.
void InitSampleTable(MinstrelWifiRemoteStation *station)
Initialize Sample Table.
TracedValue< uint64_t > m_currentRate
Trace rate changes.
Time m_updateStats
how frequent do we calculate the stats
bool DoNeedRetransmission(WifiRemoteStation *st, Ptr< const Packet > packet, bool normally) override
void UpdatePacketCounters(MinstrelWifiRemoteStation *station)
Update packet counters.
void UpdateRate(MinstrelWifiRemoteStation *station)
Update the rate.
void PrintTable(MinstrelWifiRemoteStation *station)
Print Minstrel Table.
uint16_t GetNextSample(MinstrelWifiRemoteStation *station)
Get the next sample from Sample Table.
int64_t AssignStreams(int64_t stream) override
Assign a fixed random variable stream number to the random variables used by this model.
void DoReportRtsFailed(WifiRemoteStation *station) override
This method is a pure virtual method that must be implemented by the sub-class.
void DoReportRxOk(WifiRemoteStation *station, double rxSnr, WifiMode txMode) override
This method is a pure virtual method that must be implemented by the sub-class.
uint8_t m_ewmaLevel
exponential weighted moving average
void SetupPhy(const Ptr< WifiPhy > phy) override
Set up PHY associated with this device since it is the object that knows the full set of transmit rat...
uint32_t CountRetries(MinstrelWifiRemoteStation *station)
Get the number of retries.
void UpdateRetry(MinstrelWifiRemoteStation *station)
Update the number of retries and reset accordingly.
WifiTxVector GetDataTxVector(MinstrelWifiRemoteStation *station)
Get data transmit vector.
Smart pointer class similar to boost::intrusive_ptr.
static Time Now()
Return the current simulation virtual time.
Simulation virtual time values and global simulation resolution.
int64_t GetMicroSeconds() const
Get an approximation of the time stored in this instance in the indicated unit.
a unique identifier for an interface.
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Hold an unsigned integer type.
represent a single transmission mode
WifiModulationClass GetModulationClass() const
uint64_t GetDataRate(MHz_u channelWidth, Time guardInterval, uint8_t nss) const
Time GetSlot() const
Return the slot duration for this PHY.
Time GetSifs() const
Return the Short Interframe Space (SIFS) for this PHY.
Time GetAckTxTime() const
Return the estimated Ack TX time for this PHY.
hold a list of per-remote-station state.
uint8_t GetDefaultTxPowerLevel() const
uint8_t GetNSupported(const WifiRemoteStation *station) const
Return the number of modes supported by the given station.
Ptr< WifiPhy > GetPhy() const
Return the WifiPhy.
MHz_u GetChannelWidth(const WifiRemoteStation *station) const
Return the channel width supported by the station.
bool GetAggregation(const WifiRemoteStation *station) const
Return whether the given station supports A-MPDU.
bool GetHtSupported() const
Return whether the device has HT capability support enabled on the link this manager is associated wi...
WifiMode GetNonErpSupported(const WifiRemoteStation *station, uint8_t i) const
Return whether non-ERP mode associated with the specified station at the specified index.
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...
bool GetUseNonErpProtection() const
Return whether the device supports protection of non-ERP stations.
bool GetVhtSupported() const
Return whether the device has VHT capability support enabled on the link this manager is associated w...
bool GetShortPreambleEnabled() const
Return whether the device uses short PHY preambles.
WifiMode GetSupported(const WifiRemoteStation *station, uint8_t i) const
Return whether mode associated with the specified station at the specified index.
bool GetHeSupported() const
Return whether the device has HE capability support enabled.
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...
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
void SetMode(WifiMode mode)
Sets the selected payload transmission mode.
void SetPreambleType(WifiPreamble preamble)
Sets the preamble type.
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file,...
#define NS_FATAL_ERROR(msg)
Report a fatal error with a message and terminate.
#define NS_ABORT_MSG_IF(cond, msg)
Abnormal program termination if a condition is true, with a message.
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
Ptr< T > CreateObject(Args &&... args)
Create an object by type, with varying number of constructor parameters.
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Time NanoSeconds(uint64_t value)
Construct a Time in the indicated unit.
Time Seconds(double value)
Construct a Time in the indicated unit.
Time MilliSeconds(uint64_t value)
Construct a Time in the indicated unit.
Ptr< const TraceSourceAccessor > MakeTraceSourceAccessor(T a)
Create a TraceSourceAccessor which will control access to the underlying trace source.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Ptr< const AttributeChecker > MakeBooleanChecker()
Ptr< const AttributeChecker > MakeUintegerChecker()
std::vector< RateInfo > MinstrelRate
Data structure for a Minstrel Rate table A vector of a struct RateInfo.
Ptr< const AttributeAccessor > MakeTimeAccessor(T1 a1)
Ptr< const AttributeAccessor > MakeUintegerAccessor(T1 a1)
WifiPreamble GetPreambleForTransmission(WifiModulationClass modulation, bool useShortPreamble)
Return the preamble to be used for the transmission.
Ptr< const AttributeAccessor > MakeBooleanAccessor(T1 a1)
std::vector< std::vector< uint8_t > > SampleRate
Data structure for a Sample Rate table A vector of a vector uint8_t.
Ptr< const AttributeChecker > MakeTimeChecker()
Helper to make an unbounded Time checker.
hold per-remote-station state for Minstrel Wifi manager.
uint16_t m_maxTpRate2
second highest throughput rate in bps
Time m_nextStatsUpdate
10 times every second
bool m_initialized
for initializing tables
uint16_t m_sampleRate
current sample rate in bps
uint8_t m_index
vector index
int m_numSamplesDeferred
number samples deferred
uint16_t m_txrate
current transmit rate in bps
int m_totalPacketsCount
total number of packets as of now
bool m_isSampling
a flag to indicate we are currently sampling
MinstrelRate m_minstrelTable
minstrel table
uint32_t m_shortRetry
short retries such as control packets
uint32_t m_retry
total retries short + long
uint16_t m_maxTpRate
the current throughput rate in bps
bool m_sampleDeferred
a flag to indicate sample rate is on the second stage
uint8_t m_nModes
number of modes supported
SampleRate m_sampleTable
sample table
int m_samplePacketsCount
how many packets we have sample so far
std::ofstream m_statsFile
stats file
uint8_t m_col
To keep track of the current position in the our random sample table going row by row from 1st column...
uint32_t m_longRetry
long retries such as data packets
uint16_t m_maxProbRate
rate with highest probability of success in bps
A struct to contain all information related to a data rate.
uint32_t ewmaProb
EWMA calculation ewma_prob =[prob *(100 - ewma_level) + (ewma_prob_old * ewma_level)]/100.
uint32_t adjustedRetryCount
adjust the retry limit for this rate
uint32_t prevNumRateSuccess
Number of successful frames transmitted with previous rate.
uint32_t prob
(# packets success)/(# total packets)
Time perfectTxTime
Perfect transmission time calculation, or frame calculation Given a bit rate and a packet length n by...
uint64_t successHist
Aggregate of all transmission successes.
uint32_t throughput
throughput of a rate in bps
uint32_t prevNumRateAttempt
Number of transmission attempts with previous rate.
uint64_t attemptHist
Aggregate of all transmission attempts.
hold per-remote-station state.
WifiRemoteStationState * m_state
Remote station state.
Mac48Address m_address
Mac48Address of the remote station.