A Discrete-Event Network Simulator
API
Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
ns3::MinstrelWifiManager Class Reference

Implementation of Minstrel Rate Control AlgorithmMinstrel is a rate control algorithm implemented in MadWifi and Linux. More...

#include "minstrel-wifi-manager.h"

+ Inheritance diagram for ns3::MinstrelWifiManager:

Public Member Functions

 MinstrelWifiManager ()
 
virtual ~MinstrelWifiManager ()
 
int64_t AssignStreams (int64_t stream)
 Assign a fixed random variable stream number to the random variables used by this model. More...
 
void CheckInit (MinstrelWifiRemoteStation *station)
 check for initializations More...
 
uint32_t CountRetries (MinstrelWifiRemoteStation *station)
 Count retries. More...
 
uint16_t FindRate (MinstrelWifiRemoteStation *station)
 find a rate to use from Minstrel Table More...
 
WifiTxVector GetDataTxVector (MinstrelWifiRemoteStation *station)
 Get data transmit vector. More...
 
WifiTxVector GetRtsTxVector (MinstrelWifiRemoteStation *station)
 Get RTS transmit vector. More...
 
void InitSampleTable (MinstrelWifiRemoteStation *station)
 initialize Sample Table More...
 
void SetHeSupported (bool enable)
 Enable or disable HE capability support. More...
 
void SetHtSupported (bool enable)
 Enable or disable HT capability support. More...
 
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 parameters (e.g. More...
 
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 rates that are supported. More...
 
void SetVhtSupported (bool enable)
 Enable or disable VHT capability support. More...
 
void UpdatePacketCounters (MinstrelWifiRemoteStation *station)
 Update packet counters. More...
 
void UpdateRate (MinstrelWifiRemoteStation *station)
 updating the rate More...
 
void UpdateRetry (MinstrelWifiRemoteStation *station)
 update the number of retries and reset accordingly More...
 
void UpdateStats (MinstrelWifiRemoteStation *station)
 updating the Minstrel Table every 1/10 seconds More...
 
- Public Member Functions inherited from ns3::WifiRemoteStationManager
 WifiRemoteStationManager ()
 
virtual ~WifiRemoteStationManager ()
 
void AddAllSupportedMcs (Mac48Address address)
 Invoked in a STA or AP to store all of the MCS supported by a destination which is also supported locally. More...
 
void AddAllSupportedModes (Mac48Address address)
 Invoked in a STA or AP to store all of the modes supported by a destination which is also supported locally. More...
 
void AddBasicMcs (WifiMode mcs)
 Add a given Modulation and Coding Scheme (MCS) index to the set of basic MCS. More...
 
void AddBasicMode (WifiMode mode)
 Invoked in a STA upon association to store the set of rates which belong to the BSSBasicRateSet of the associated AP and which are supported locally. More...
 
void AddStationHeCapabilities (Mac48Address from, HeCapabilities hecapabilities)
 Records HE capabilities of the remote station. More...
 
void AddStationHtCapabilities (Mac48Address from, HtCapabilities htcapabilities)
 Records HT capabilities of the remote station. More...
 
void AddStationVhtCapabilities (Mac48Address from, VhtCapabilities vhtcapabilities)
 Records VHT capabilities of the remote station. More...
 
void AddSupportedErpSlotTime (Mac48Address address, bool isShortSlotTimeSupported)
 Record whether the short ERP slot time is supported by the station. More...
 
void AddSupportedMcs (Mac48Address address, WifiMode mcs)
 Record the MCS index supported by the station. More...
 
void AddSupportedMode (Mac48Address address, WifiMode mode)
 Invoked in a STA or AP to store the set of modes supported by a destination which is also supported locally. More...
 
void AddSupportedPlcpPreamble (Mac48Address address, bool isShortPreambleSupported)
 Record whether the short PLCP preamble is supported by the station. More...
 
WifiTxVector DoGetCtsToSelfTxVector (void)
 Since CTS-to-self parameters are not dependent on the station, it is implemented in wifiremote station manager. More...
 
WifiTxVector GetAckTxVector (Mac48Address address, WifiMode dataMode)
 
WifiMode GetBasicMcs (uint8_t i) const
 Return the MCS at the given list index. More...
 
WifiMode GetBasicMode (uint8_t i) const
 Return a basic mode from the set of basic modes. More...
 
WifiTxVector GetBlockAckTxVector (Mac48Address address, WifiMode dataMode)
 
uint16_t GetChannelWidthSupported (Mac48Address address) const
 Return the channel width supported by the station. More...
 
WifiTxVector GetCtsToSelfTxVector (const WifiMacHeader *header, Ptr< const Packet > packet)
 
WifiTxVector GetCtsTxVector (Mac48Address address, WifiMode rtsMode)
 
WifiTxVector GetDataTxVector (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet)
 
WifiMode GetDefaultMcs (void) const
 Return the default Modulation and Coding Scheme (MCS) index. More...
 
WifiMode GetDefaultMode (void) const
 Return the default transmission mode. More...
 
uint8_t GetDefaultTxPowerLevel (void) const
 
uint32_t GetFragmentationThreshold (void) const
 Return the fragmentation threshold. More...
 
uint32_t GetFragmentOffset (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet, uint32_t fragmentNumber)
 
uint32_t GetFragmentSize (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet, uint32_t fragmentNumber)
 
bool GetGreenfieldSupported (Mac48Address address) const
 Return whether the station supports Greenfield or not. More...
 
bool GetHtSupported (Mac48Address address) const
 Return whether the station supports HT or not. More...
 
WifiRemoteStationInfo GetInfo (Mac48Address address)
 
uint8_t GetMaxNumberOfTransmitStreams (void)
 
uint8_t GetNBasicMcs (void) const
 Return the number of basic MCS index. More...
 
uint8_t GetNBasicModes (void) const
 Return the number of basic modes we support. More...
 
uint8_t GetNMcsSupported (Mac48Address address) const
 Return the number of MCS supported by the station. More...
 
uint32_t GetNNonErpBasicModes (void) const
 Return the number of non-ERP basic modes we support. More...
 
WifiMode GetNonErpBasicMode (uint8_t i) const
 Return a basic mode from the set of basic modes that is not an ERP mode. More...
 
WifiMode GetNonUnicastMode (void) const
 Return a mode for non-unicast packets. More...
 
uint8_t GetNumberOfAntennas (void)
 
uint8_t GetNumberOfSupportedStreams (Mac48Address address) const
 Return the number of spatial streams supported by the station. More...
 
bool GetQosSupported (Mac48Address address) const
 Return whether the given station is QoS capable. More...
 
bool GetRifsPermitted (void) const
 Return whether the device can use RIFS. More...
 
WifiTxVector GetRtsTxVector (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet)
 
bool GetShortGuardInterval (Mac48Address address) const
 Return whether the station supports HT/VHT short guard interval. More...
 
bool GetShortPreambleEnabled (void) const
 Return whether the device uses short PLCP preambles. More...
 
bool GetShortPreambleSupported (Mac48Address address) const
 Return whether the station supports short PLCP preamble or not. More...
 
bool GetShortSlotTimeEnabled (void) const
 Return whether the device uses short slot time. More...
 
bool GetShortSlotTimeSupported (Mac48Address address) const
 Return whether the station supports short ERP slot time or not. More...
 
bool GetUseGreenfieldProtection (void) const
 Return whether protection for stations that do not support HT greenfield format is enabled. More...
 
bool GetUseNonErpProtection (void) const
 Return whether the device supports protection of non-ERP stations. More...
 
bool GetUseNonHtProtection (void) const
 Return whether the device supports protection of non-HT stations. More...
 
bool GetVhtSupported (Mac48Address address) const
 Return whether the station supports VHT or not. More...
 
bool HasHeSupported (void) const
 Return whether the device has HE capability support enabled. More...
 
bool HasHtSupported (void) const
 Return whether the device has HT capability support enabled. More...
 
bool HasPcfSupported (void) const
 Return whether the device has PCF capability support enabled. More...
 
bool HasVhtSupported (void) const
 Return whether the device has VHT capability support enabled. More...
 
bool IsAssociated (Mac48Address address) const
 Return whether the station associated. More...
 
bool IsBrandNew (Mac48Address address) const
 Return whether the station state is brand new. More...
 
bool IsLastFragment (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet, uint32_t fragmentNumber)
 
bool IsWaitAssocTxOk (Mac48Address address) const
 Return whether we are waiting for an ACK for the association response we sent. More...
 
bool NeedCtsToSelf (WifiTxVector txVector)
 Return if we need to do Cts-to-self before sending a DATA. More...
 
bool NeedFragmentation (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet)
 
bool NeedRetransmission (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet)
 
bool NeedRts (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet, WifiTxVector txVector)
 
void PrepareForQueue (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet)
 
void RecordDisassociated (Mac48Address address)
 Records that the STA was disassociated. More...
 
void RecordGotAssocTxFailed (Mac48Address address)
 Records that we missed an ACK for the association response we sent. More...
 
void RecordGotAssocTxOk (Mac48Address address)
 Records that we got an ACK for the association response we sent. More...
 
void RecordWaitAssocTxOk (Mac48Address address)
 Records that we are waiting for an ACK for the association response we sent. More...
 
void RemoveAllSupportedMcs (Mac48Address address)
 Invoked in a STA or AP to delete all of the supported MCS by a destination. More...
 
void ReportAmpduTxStatus (Mac48Address address, uint8_t tid, uint8_t nSuccessfulMpdus, uint8_t nFailedMpdus, double rxSnr, double dataSnr)
 Typically called per A-MPDU, either when a Block ACK was successfully received or when a BlockAckTimeout has elapsed. More...
 
void ReportDataFailed (Mac48Address address, const WifiMacHeader *header, uint32_t packetSize)
 Should be invoked whenever the AckTimeout associated to a transmission attempt expires. More...
 
void ReportDataOk (Mac48Address address, const WifiMacHeader *header, double ackSnr, WifiMode ackMode, double dataSnr, uint32_t packetSize)
 Should be invoked whenever we receive the Ack associated to a data packet we just sent. More...
 
void ReportFinalDataFailed (Mac48Address address, const WifiMacHeader *header, uint32_t packetSize)
 Should be invoked after calling ReportDataFailed if NeedRetransmission returns false. More...
 
void ReportFinalRtsFailed (Mac48Address address, const WifiMacHeader *header)
 Should be invoked after calling ReportRtsFailed if NeedRetransmission returns false. More...
 
void ReportRtsFailed (Mac48Address address, const WifiMacHeader *header)
 Should be invoked whenever the RtsTimeout associated to a transmission attempt expires. More...
 
void ReportRtsOk (Mac48Address address, const WifiMacHeader *header, double ctsSnr, WifiMode ctsMode, double rtsSnr)
 Should be invoked whenever we receive the Cts associated to an RTS we just sent. More...
 
void ReportRxOk (Mac48Address address, const WifiMacHeader *header, double rxSnr, WifiMode txMode)
 
void Reset (void)
 Reset the station, invoked in a STA upon dis-association or in an AP upon reboot. More...
 
void SetDefaultTxPowerLevel (uint8_t txPower)
 Set the default transmission power level. More...
 
void SetFragmentationThreshold (uint32_t threshold)
 Sets a fragmentation threshold. More...
 
void SetMaxSlrc (uint32_t maxSlrc)
 Sets the maximum STA long retry count (SLRC). More...
 
void SetMaxSsrc (uint32_t maxSsrc)
 Sets the maximum STA short retry count (SSRC). More...
 
virtual void SetPcfSupported (bool enable)
 Enable or disable PCF capability support. More...
 
void SetQosSupport (Mac48Address from, bool qosSupported)
 Records QoS support of the remote station. More...
 
void SetRifsPermitted (bool allow)
 Permit or prohibit RIFS. More...
 
void SetRtsCtsThreshold (uint32_t threshold)
 Sets the RTS threshold. More...
 
void SetShortPreambleEnabled (bool enable)
 Enable or disable short PLCP preambles. More...
 
void SetShortSlotTimeEnabled (bool enable)
 Enable or disable short slot time. More...
 
void SetUseGreenfieldProtection (bool enable)
 Enable or disable protection for stations that do not support HT greenfield format. More...
 
void SetUseNonErpProtection (bool enable)
 Enable or disable protection for non-ERP stations. More...
 
void SetUseNonHtProtection (bool enable)
 Enable or disable protection for non-HT stations. More...
 
void UpdateFragmentationThreshold (void)
 Typically called to update the fragmentation threshold at the start of a new transmission. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::WifiRemoteStationManager
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Types

typedef std::map< WifiMode, TimeTxTime
 typedef for a vector of a pair of Time, WifiMode. More...
 

Private Member Functions

void AddCalcTxTime (WifiMode mode, Time t)
 Add transmission time for the given mode to an internal list. More...
 
Time CalculateTimeUnicastPacket (Time dataTransmissionTime, uint32_t shortRetries, uint32_t longRetries)
 Estimate the time to transmit the given packet with the given number of retries. More...
 
WifiRemoteStationDoCreateStation (void) const
 
WifiTxVector DoGetDataTxVector (WifiRemoteStation *station)
 
WifiTxVector DoGetRtsTxVector (WifiRemoteStation *station)
 
bool DoNeedRetransmission (WifiRemoteStation *st, Ptr< const Packet > packet, bool normally)
 
void DoReportDataFailed (WifiRemoteStation *station)
 This method is a pure virtual method that must be implemented by the sub-class. More...
 
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. More...
 
void DoReportFinalDataFailed (WifiRemoteStation *station)
 This method is a pure virtual method that must be implemented by the sub-class. More...
 
void DoReportFinalRtsFailed (WifiRemoteStation *station)
 This method is a pure virtual method that must be implemented by the sub-class. More...
 
void DoReportRtsFailed (WifiRemoteStation *station)
 This method is a pure virtual method that must be implemented by the sub-class. More...
 
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. More...
 
void DoReportRxOk (WifiRemoteStation *station, double rxSnr, WifiMode txMode)
 This method is a pure virtual method that must be implemented by the sub-class. More...
 
Time GetCalcTxTime (WifiMode mode) const
 for estimating the TxTime of a packet with a given mode More...
 
uint16_t GetNextSample (MinstrelWifiRemoteStation *station)
 getting the next sample from Sample Table More...
 
bool IsLowLatency (void) const
 
void PrintSampleTable (MinstrelWifiRemoteStation *station)
 printing Sample Table More...
 
void PrintTable (MinstrelWifiRemoteStation *station)
 printing Minstrel Table More...
 
void RateInit (MinstrelWifiRemoteStation *station)
 initialize Minstrel Table More...
 

Private Attributes

TxTime m_calcTxTime
 to hold all the calculated TxTime for all modes More...
 
TracedValue< uint64_t > m_currentRate
 Trace rate changes. More...
 
uint8_t m_ewmaLevel
 exponential weighted moving average More...
 
uint8_t m_lookAroundRate
 the % to try other rates than our current rate More...
 
uint32_t m_pktLen
 packet length used for calculate mode TxTime More...
 
bool m_printSamples
 whether samples table should be printed. More...
 
bool m_printStats
 whether statistics table should be printed. More...
 
uint8_t m_sampleCol
 number of sample columns More...
 
Ptr< UniformRandomVariablem_uniformRandomVariable
 Provides uniform random variables. More...
 
Time m_updateStats
 how frequent do we calculate the stats (1/10 seconds) More...
 

Additional Inherited Members

- Public Types inherited from ns3::WifiRemoteStationManager
typedef void(* PowerChangeTracedCallback) (double oldPower, double newPower, Mac48Address remoteAddress)
 TracedCallback signature for power change events. More...
 
enum  ProtectionMode { RTS_CTS, CTS_TO_SELF }
 ProtectionMode enumeration. More...
 
typedef void(* RateChangeTracedCallback) (DataRate oldRate, DataRate newRate, Mac48Address remoteAddress)
 TracedCallback signature for rate change events. More...
 
- Protected Member Functions inherited from ns3::WifiRemoteStationManager
virtual void DoDispose (void)
 Destructor implementation. More...
 
Mac48Address GetAddress (const WifiRemoteStation *station) const
 Return the address of the station. More...
 
bool GetAggregation (const WifiRemoteStation *station) const
 Return whether the given station supports A-MPDU. More...
 
uint16_t GetChannelWidth (const WifiRemoteStation *station) const
 Return the channel width supported by the station. More...
 
bool GetGreenfield (const WifiRemoteStation *station) const
 Return whether the station supports Greenfield or not. More...
 
uint16_t GetGuardInterval (const WifiRemoteStation *station) const
 Return the HE guard interval duration supported by the station. More...
 
bool GetHeSupported (const WifiRemoteStation *station) const
 Return whether the given station is HE capable. More...
 
bool GetHtSupported (const WifiRemoteStation *station) const
 Return whether the given station is HT capable. More...
 
Ptr< WifiMacGetMac (void) const
 Return the WifiMac. More...
 
WifiMode GetMcsSupported (const WifiRemoteStation *station, uint8_t i) const
 Return the WifiMode supported by the specified station at the specified index. More...
 
uint8_t GetNess (const WifiRemoteStation *station) const
 
uint8_t GetNMcsSupported (const WifiRemoteStation *station) const
 Return the number of MCS supported by the given station. More...
 
uint32_t GetNNonErpSupported (const WifiRemoteStation *station) const
 Return the number of non-ERP modes supported by the given station. More...
 
WifiMode GetNonErpSupported (const WifiRemoteStation *station, uint8_t i) const
 Return whether non-ERP mode associated with the specified station at the specified index. More...
 
uint8_t GetNSupported (const WifiRemoteStation *station) const
 Return the number of modes supported by the given station. More...
 
uint8_t GetNumberOfSupportedStreams (const WifiRemoteStation *station) const
 Return the number of supported streams the station has. More...
 
Ptr< WifiPhyGetPhy (void) const
 Return the WifiPhy. More...
 
WifiPreamble GetPreambleForTransmission (WifiMode mode, Mac48Address dest)
 Return the preamble to be used for the transmission. More...
 
bool GetQosSupported (const WifiRemoteStation *station) const
 Return whether the given station is QoS capable. More...
 
bool GetShortGuardInterval (const WifiRemoteStation *station) const
 Return whether the given station supports HT/VHT short guard interval. More...
 
WifiMode GetSupported (const WifiRemoteStation *station, uint8_t i) const
 Return whether mode associated with the specified station at the specified index. More...
 
bool GetVhtSupported (const WifiRemoteStation *station) const
 Return whether the given station is VHT capable. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 
- Static Protected Member Functions inherited from ns3::WifiRemoteStationManager
static uint16_t GetChannelWidthForTransmission (WifiMode mode, uint16_t maxSupportedChannelWidth)
 Return the channel width that corresponds to the selected mode (instead of letting the PHY's default channel width). More...
 

Detailed Description

Implementation of Minstrel Rate Control Algorithm

Minstrel is a rate control algorithm implemented in MadWifi and Linux.


The basic principle is to probe the environment and adapt the rate based on statistics collected on the probability of successful transmission. The algorithm adapts the rate to the highest rate that it considers successful, and spends a fraction of its time doing 'look around' by trying other rates.

Minstrel is appropriate for non-HT/VHT/HE configurations; for HT/VHT/HE (i.e. 802.11n/ac/ax), users should use MinstrelHtWifiManager instead. Minstrel will error exit if the user tries to configure it with a Wi-Fi MAC that has VhtSupported, HtSupported or HeSupported set.

Some notes on this implementation follow. The implementation has been adapted to bring it closer to the Linux implementation. For each rate, a new parameter samplesSkipped is added. This parameter is intended to solve an issue regarding the sampling of low rates when a high rate is working well, which leads to outdated statistics. This change makes throughput a bit lower in simple, stable scenarios, but may help in dynamic scenarios to react faster and more accurately to changes.

Related to the previous, the logic for deciding when to sample random rates is as follows. When a sample rate is deferred to the second MRR chain stage, a new parameter (numSamplesDeferred) is increased. This parameters is used (jointly with sampleCount) to compare current sample count with the lookaround rate.

Also related with sampling, another parameter sampleLimit is added. This parameter limits the number of times a very low or very high probability rate is sampled, avoiding to try a poorly working sample rate too often.

When updating the EWMA probability of a rate for the first time, it does not apply EWMA but instead assigns the entire probability. Since the EWMA probability is initialized to zero, this generates a more accurate EWMA.

Config Paths

ns3::MinstrelWifiManager is accessible through the following paths with Config::Set and Config::Connect:

Attributes

Attributes defined in parent class ns3::WifiRemoteStationManager

TraceSources

TraceSources defined in parent class ns3::WifiRemoteStationManager

Size of this type is 384 bytes (on a 64-bit architecture).

Definition at line 157 of file minstrel-wifi-manager.h.

Member Typedef Documentation

◆ TxTime

typedef std::map<WifiMode,Time> ns3::MinstrelWifiManager::TxTime
private

typedef for a vector of a pair of Time, WifiMode.

Essentially a map from WifiMode to its corresponding transmission time to transmit a reference packet.

Definition at line 353 of file minstrel-wifi-manager.h.

Constructor & Destructor Documentation

◆ MinstrelWifiManager()

ns3::MinstrelWifiManager::MinstrelWifiManager ( )

Definition at line 99 of file minstrel-wifi-manager.cc.

References m_uniformRandomVariable, and NS_LOG_FUNCTION.

◆ ~MinstrelWifiManager()

ns3::MinstrelWifiManager::~MinstrelWifiManager ( )
virtual

Definition at line 107 of file minstrel-wifi-manager.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ AddCalcTxTime()

void ns3::MinstrelWifiManager::AddCalcTxTime ( WifiMode  mode,
Time  t 
)
private

Add transmission time for the given mode to an internal list.

Parameters
modeWi-Fi mode
ttransmission time

Definition at line 153 of file minstrel-wifi-manager.cc.

References m_calcTxTime, and NS_LOG_FUNCTION.

Referenced by SetupPhy().

◆ AssignStreams()

int64_t ns3::MinstrelWifiManager::AssignStreams ( int64_t  stream)

Assign a fixed random variable stream number to the random variables used by this model.

Return the number of streams (possibly zero) that have been assigned.

Parameters
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

Definition at line 136 of file minstrel-wifi-manager.cc.

References m_uniformRandomVariable, NS_LOG_FUNCTION, and ns3::RandomVariableStream::SetStream().

◆ CalculateTimeUnicastPacket()

Time ns3::MinstrelWifiManager::CalculateTimeUnicastPacket ( Time  dataTransmissionTime,
uint32_t  shortRetries,
uint32_t  longRetries 
)
private

Estimate the time to transmit the given packet with the given number of retries.

This function is "roughly" the function "calc_usecs_unicast_packet" in minstrel.c in the madwifi implementation.

The basic idea is that, we try to estimate the "average" time used to transmit the packet for the given number of retries while also accounting for the 802.11 congestion window change. The original code in the madwifi seems to estimate the number of backoff slots as the half of the current CW size.

There are four main parts:

  • wait for DIFS (sense idle channel)
  • ACK timeouts
  • DATA transmission
  • backoffs according to CW
Parameters
dataTransmissionTimethe data transmission time
shortRetriesshort retries
longRetrieslong retries
Returns
the unicast packet time

Definition at line 952 of file minstrel-wifi-manager.cc.

References ns3::WifiRemoteStationManager::GetMac(), min, ns3::NanoSeconds(), and NS_LOG_FUNCTION.

Referenced by RateInit().

◆ CheckInit()

void ns3::MinstrelWifiManager::CheckInit ( MinstrelWifiRemoteStation station)

◆ CountRetries()

uint32_t ns3::MinstrelWifiManager::CountRetries ( MinstrelWifiRemoteStation station)

◆ DoCreateStation()

WifiRemoteStation * ns3::MinstrelWifiManager::DoCreateStation ( void  ) const
privatevirtual

◆ DoGetDataTxVector()

WifiTxVector ns3::MinstrelWifiManager::DoGetDataTxVector ( WifiRemoteStation station)
privatevirtual
Parameters
stationthe station that we need to communicate
Returns
the TXVECTOR to use to send a packet to the station

Note: This method is called before sending a unicast packet or a fragment of a unicast packet to decide which transmission mode to use.

Implements ns3::WifiRemoteStationManager.

Definition at line 842 of file minstrel-wifi-manager.cc.

References GetDataTxVector(), and NS_LOG_FUNCTION.

◆ DoGetRtsTxVector()

WifiTxVector ns3::MinstrelWifiManager::DoGetRtsTxVector ( WifiRemoteStation station)
privatevirtual
Parameters
stationthe station that we need to communicate
Returns
the transmission mode to use to send an rts to the station

Note: This method is called before sending an rts to a station to decide which transmission mode to use for the rts.

Implements ns3::WifiRemoteStationManager.

Definition at line 850 of file minstrel-wifi-manager.cc.

References GetRtsTxVector(), and NS_LOG_FUNCTION.

◆ DoNeedRetransmission()

bool ns3::MinstrelWifiManager::DoNeedRetransmission ( WifiRemoteStation station,
Ptr< const Packet packet,
bool  normally 
)
privatevirtual
Parameters
stationthe station that we need to communicate
packetthe packet to send
normallyindicates whether the normal 802.11 data retransmission mechanism would request that the data is retransmitted or not.
Returns
true if we want to resend a packet after a failed transmission attempt, false otherwise.

Note: This method is called after any unicast packet transmission (control, management, or data) has been attempted and has failed.

Reimplemented from ns3::WifiRemoteStationManager.

Definition at line 858 of file minstrel-wifi-manager.cc.

References CheckInit(), CountRetries(), ns3::MinstrelWifiRemoteStation::m_initialized, ns3::MinstrelWifiRemoteStation::m_longRetry, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

◆ DoReportDataFailed()

void ns3::MinstrelWifiManager::DoReportDataFailed ( WifiRemoteStation station)
privatevirtual

This method is a pure virtual method that must be implemented by the sub-class.

This allows different types of WifiRemoteStationManager to respond differently,

Parameters
stationthe station that we failed to send DATA

Implements ns3::WifiRemoteStationManager.

Definition at line 731 of file minstrel-wifi-manager.cc.

References CheckInit(), ns3::MinstrelWifiRemoteStation::m_initialized, ns3::MinstrelWifiRemoteStation::m_longRetry, ns3::MinstrelWifiRemoteStation::m_txrate, NS_LOG_DEBUG, NS_LOG_FUNCTION, and UpdateRate().

◆ DoReportDataOk()

void ns3::MinstrelWifiManager::DoReportDataOk ( WifiRemoteStation station,
double  ackSnr,
WifiMode  ackMode,
double  dataSnr 
)
privatevirtual

This method is a pure virtual method that must be implemented by the sub-class.

This allows different types of WifiRemoteStationManager to respond differently,

Parameters
stationthe station that we successfully sent RTS
ackSnrthe SNR of the ACK we received
ackModethe WifiMode the receiver used to send the ACK
dataSnrthe SNR of the DATA we sent

Implements ns3::WifiRemoteStationManager.

Definition at line 746 of file minstrel-wifi-manager.cc.

References CheckInit(), FindRate(), ns3::MinstrelWifiRemoteStation::m_initialized, ns3::MinstrelWifiRemoteStation::m_minstrelTable, ns3::MinstrelWifiRemoteStation::m_nModes, ns3::MinstrelWifiRemoteStation::m_txrate, NS_LOG_DEBUG, NS_LOG_FUNCTION, UpdatePacketCounters(), UpdateRetry(), and UpdateStats().

◆ DoReportFinalDataFailed()

void ns3::MinstrelWifiManager::DoReportFinalDataFailed ( WifiRemoteStation station)
privatevirtual

This method is a pure virtual method that must be implemented by the sub-class.

This allows different types of WifiRemoteStationManager to respond differently,

Parameters
stationthe station that we failed to send DATA

Implements ns3::WifiRemoteStationManager.

Definition at line 778 of file minstrel-wifi-manager.cc.

References CheckInit(), FindRate(), ns3::MinstrelWifiRemoteStation::m_initialized, ns3::MinstrelWifiRemoteStation::m_minstrelTable, ns3::MinstrelWifiRemoteStation::m_nModes, ns3::MinstrelWifiRemoteStation::m_txrate, NS_LOG_DEBUG, NS_LOG_FUNCTION, UpdatePacketCounters(), UpdateRetry(), and UpdateStats().

◆ DoReportFinalRtsFailed()

void ns3::MinstrelWifiManager::DoReportFinalRtsFailed ( WifiRemoteStation station)
privatevirtual

This method is a pure virtual method that must be implemented by the sub-class.

This allows different types of WifiRemoteStationManager to respond differently,

Parameters
stationthe station that we failed to send RTS

Implements ns3::WifiRemoteStationManager.

Definition at line 723 of file minstrel-wifi-manager.cc.

References NS_LOG_FUNCTION, and UpdateRetry().

◆ DoReportRtsFailed()

void ns3::MinstrelWifiManager::DoReportRtsFailed ( WifiRemoteStation station)
privatevirtual

This method is a pure virtual method that must be implemented by the sub-class.

This allows different types of WifiRemoteStationManager to respond differently,

Parameters
stationthe station that we failed to send RTS

Implements ns3::WifiRemoteStationManager.

Definition at line 708 of file minstrel-wifi-manager.cc.

References ns3::MinstrelWifiRemoteStation::m_shortRetry, ns3::MinstrelWifiRemoteStation::m_txrate, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

◆ DoReportRtsOk()

void ns3::MinstrelWifiManager::DoReportRtsOk ( WifiRemoteStation station,
double  ctsSnr,
WifiMode  ctsMode,
double  rtsSnr 
)
privatevirtual

This method is a pure virtual method that must be implemented by the sub-class.

This allows different types of WifiRemoteStationManager to respond differently,

Parameters
stationthe station that we successfully sent RTS
ctsSnrthe SNR of the CTS we received
ctsModethe WifiMode the receiver used to send the CTS
rtsSnrthe SNR of the RTS we sent

Implements ns3::WifiRemoteStationManager.

Definition at line 717 of file minstrel-wifi-manager.cc.

References NS_LOG_FUNCTION.

◆ DoReportRxOk()

void ns3::MinstrelWifiManager::DoReportRxOk ( WifiRemoteStation station,
double  rxSnr,
WifiMode  txMode 
)
privatevirtual

This method is a pure virtual method that must be implemented by the sub-class.

This allows different types of WifiRemoteStationManager to respond differently,

Parameters
stationthe station that sent the DATA to us
rxSnrthe SNR of the DATA we received
txModethe WifiMode the sender used to send the DATA

Implements ns3::WifiRemoteStationManager.

Definition at line 701 of file minstrel-wifi-manager.cc.

References NS_LOG_DEBUG, and NS_LOG_FUNCTION.

◆ FindRate()

uint16_t ns3::MinstrelWifiManager::FindRate ( MinstrelWifiRemoteStation station)

◆ GetCalcTxTime()

Time ns3::MinstrelWifiManager::GetCalcTxTime ( WifiMode  mode) const
private

for estimating the TxTime of a packet with a given mode

Parameters
modeWi-Fi mode
Returns
the transmission time

Definition at line 144 of file minstrel-wifi-manager.cc.

References m_calcTxTime, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by RateInit().

◆ GetDataTxVector()

WifiTxVector ns3::MinstrelWifiManager::GetDataTxVector ( MinstrelWifiRemoteStation station)

◆ GetNextSample()

uint16_t ns3::MinstrelWifiManager::GetNextSample ( MinstrelWifiRemoteStation station)
private

getting the next sample from Sample Table

Parameters
stationthe station object
Returns
the next sample

Definition at line 887 of file minstrel-wifi-manager.cc.

References ns3::MinstrelWifiRemoteStation::m_col, ns3::MinstrelWifiRemoteStation::m_index, ns3::MinstrelWifiRemoteStation::m_nModes, m_sampleCol, ns3::MinstrelWifiRemoteStation::m_sampleTable, NS_ABORT_MSG_IF, and NS_LOG_FUNCTION.

Referenced by FindRate().

◆ GetRtsTxVector()

WifiTxVector ns3::MinstrelWifiManager::GetRtsTxVector ( MinstrelWifiRemoteStation station)

◆ GetTypeId()

TypeId ns3::MinstrelWifiManager::GetTypeId ( void  )
static

◆ InitSampleTable()

void ns3::MinstrelWifiManager::InitSampleTable ( MinstrelWifiRemoteStation station)

initialize Sample Table

Parameters
stationthe station object

The next two lines basically tries to generate a random number between 0 and the number of available rates

Definition at line 978 of file minstrel-wifi-manager.cc.

References ns3::RandomVariableStream::GetInteger(), ns3::MinstrelWifiRemoteStation::m_col, ns3::MinstrelWifiRemoteStation::m_index, ns3::MinstrelWifiRemoteStation::m_nModes, m_sampleCol, ns3::MinstrelWifiRemoteStation::m_sampleTable, m_uniformRandomVariable, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by CheckInit().

◆ IsLowLatency()

bool ns3::MinstrelWifiManager::IsLowLatency ( void  ) const
privatevirtual
Returns
whether this manager is a manager designed to work in low-latency environments.

Note: In this context, low vs high latency is defined in IEEE 802.11 Rate Adaptation: A Practical Approach, by M. Lacage, M.H. Manshaei, and T. Turletti.

Implements ns3::WifiRemoteStationManager.

Definition at line 881 of file minstrel-wifi-manager.cc.

◆ PrintSampleTable()

void ns3::MinstrelWifiManager::PrintSampleTable ( MinstrelWifiRemoteStation station)
private

printing Sample Table

Parameters
stationthe station object

Definition at line 1010 of file minstrel-wifi-manager.cc.

References ns3::MinstrelWifiRemoteStation::m_nModes, m_sampleCol, ns3::MinstrelWifiRemoteStation::m_sampleTable, and NS_LOG_DEBUG.

Referenced by UpdateStats().

◆ PrintTable()

void ns3::MinstrelWifiManager::PrintTable ( MinstrelWifiRemoteStation station)
private

◆ RateInit()

void ns3::MinstrelWifiManager::RateInit ( MinstrelWifiRemoteStation station)
private

◆ SetHeSupported()

void ns3::MinstrelWifiManager::SetHeSupported ( bool  enable)
virtual

Enable or disable HE capability support.

Parameters
enableenable or disable HE capability support

Reimplemented from ns3::WifiRemoteStationManager.

Definition at line 1107 of file minstrel-wifi-manager.cc.

References NS_FATAL_ERROR.

◆ SetHtSupported()

void ns3::MinstrelWifiManager::SetHtSupported ( bool  enable)
virtual

Enable or disable HT capability support.

Parameters
enableenable or disable HT capability support

Reimplemented from ns3::WifiRemoteStationManager.

Definition at line 1087 of file minstrel-wifi-manager.cc.

References NS_FATAL_ERROR.

◆ SetupMac()

void ns3::MinstrelWifiManager::SetupMac ( const Ptr< WifiMac mac)
virtual

Set up MAC associated with this device since it is the object that knows the full set of timing parameters (e.g.

IFS).

Parameters
macthe MAC of this device

Reimplemented from ns3::WifiRemoteStationManager.

Definition at line 129 of file minstrel-wifi-manager.cc.

References third::mac, NS_LOG_FUNCTION, and ns3::WifiRemoteStationManager::SetupMac().

◆ SetupPhy()

void ns3::MinstrelWifiManager::SetupPhy ( const Ptr< WifiPhy phy)
virtual

Set up PHY associated with this device since it is the object that knows the full set of transmit rates that are supported.

Parameters
phythe PHY of this device

Reimplemented from ns3::WifiRemoteStationManager.

Definition at line 113 of file minstrel-wifi-manager.cc.

References AddCalcTxTime(), m_pktLen, NS_LOG_FUNCTION, third::phy, ns3::WifiTxVector::SetMode(), ns3::WifiTxVector::SetPreambleType(), ns3::WifiRemoteStationManager::SetupPhy(), and ns3::WIFI_PREAMBLE_LONG.

◆ SetVhtSupported()

void ns3::MinstrelWifiManager::SetVhtSupported ( bool  enable)
virtual

Enable or disable VHT capability support.

Parameters
enableenable or disable VHT capability support

Reimplemented from ns3::WifiRemoteStationManager.

Definition at line 1097 of file minstrel-wifi-manager.cc.

References NS_FATAL_ERROR.

◆ UpdatePacketCounters()

void ns3::MinstrelWifiManager::UpdatePacketCounters ( MinstrelWifiRemoteStation station)

◆ UpdateRate()

void ns3::MinstrelWifiManager::UpdateRate ( MinstrelWifiRemoteStation station)

updating the rate

Retry Chain table is implemented here.

Parameters
stationthe station object

Try | LOOKAROUND RATE | NORMAL RATE

| random < best | random > best |

1 | Best throughput | Random rate | Best throughput 2 | Random rate | Best throughput | Next best throughput 3 | Best probability | Best probability | Best probability 4 | Lowest Baserate | Lowest baserate | Lowest baserate

Note: For clarity, multiple blocks of if's and else's are used After failing max retry times, DoReportFinalDataFailed will be called

Definition at line 223 of file minstrel-wifi-manager.cc.

References ns3::MinstrelWifiRemoteStation::m_isSampling, ns3::MinstrelWifiRemoteStation::m_longRetry, ns3::MinstrelWifiRemoteStation::m_maxProbRate, ns3::MinstrelWifiRemoteStation::m_maxTpRate, ns3::MinstrelWifiRemoteStation::m_maxTpRate2, ns3::MinstrelWifiRemoteStation::m_minstrelTable, ns3::MinstrelWifiRemoteStation::m_sampleDeferred, ns3::MinstrelWifiRemoteStation::m_sampleRate, ns3::MinstrelWifiRemoteStation::m_txrate, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by DoReportDataFailed().

◆ UpdateRetry()

void ns3::MinstrelWifiManager::UpdateRetry ( MinstrelWifiRemoteStation station)

update the number of retries and reset accordingly

Parameters
stationthe station object

Definition at line 833 of file minstrel-wifi-manager.cc.

References ns3::MinstrelWifiRemoteStation::m_longRetry, ns3::MinstrelWifiRemoteStation::m_retry, ns3::MinstrelWifiRemoteStation::m_shortRetry, and NS_LOG_FUNCTION.

Referenced by DoReportDataOk(), DoReportFinalDataFailed(), and DoReportFinalRtsFailed().

◆ UpdateStats()

void ns3::MinstrelWifiManager::UpdateStats ( MinstrelWifiRemoteStation station)

updating the Minstrel Table every 1/10 seconds

Parameters
stationthe station object

calculate the probability of success assume probability scales from 0 to 18000

See: http://wireless.kernel.org/en/developers/Documentation/mac80211/RateControl/minstrel/

Analysis of information showed that the system was sampling too hard at some rates. For those rates that never work (54mb, 500m range) there is no point in retrying 10 sample packets (< 6 ms time). Consequently, for the very low probability rates, we try at most twice when fails and not sample more than 4 times.

Definition at line 522 of file minstrel-wifi-manager.cc.

References ns3::Time::GetMicroSeconds(), ns3::WifiRemoteStationManager::GetSupported(), ns3::if(), m_ewmaLevel, ns3::MinstrelWifiRemoteStation::m_initialized, ns3::MinstrelWifiRemoteStation::m_maxProbRate, ns3::MinstrelWifiRemoteStation::m_maxTpRate, ns3::MinstrelWifiRemoteStation::m_maxTpRate2, ns3::MinstrelWifiRemoteStation::m_minstrelTable, ns3::MinstrelWifiRemoteStation::m_nextStatsUpdate, ns3::MinstrelWifiRemoteStation::m_nModes, m_printSamples, m_printStats, ns3::MinstrelWifiRemoteStation::m_txrate, m_updateStats, ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, PrintSampleTable(), PrintTable(), and ns3::Seconds().

Referenced by DoReportDataOk(), DoReportFinalDataFailed(), and RateInit().

Member Data Documentation

◆ m_calcTxTime

TxTime ns3::MinstrelWifiManager::m_calcTxTime
private

to hold all the calculated TxTime for all modes

Definition at line 355 of file minstrel-wifi-manager.h.

Referenced by AddCalcTxTime(), and GetCalcTxTime().

◆ m_currentRate

TracedValue<uint64_t> ns3::MinstrelWifiManager::m_currentRate
private

Trace rate changes.

Definition at line 367 of file minstrel-wifi-manager.h.

Referenced by GetDataTxVector(), and GetTypeId().

◆ m_ewmaLevel

uint8_t ns3::MinstrelWifiManager::m_ewmaLevel
private

exponential weighted moving average

Definition at line 358 of file minstrel-wifi-manager.h.

Referenced by GetTypeId(), and UpdateStats().

◆ m_lookAroundRate

uint8_t ns3::MinstrelWifiManager::m_lookAroundRate
private

the % to try other rates than our current rate

Definition at line 357 of file minstrel-wifi-manager.h.

Referenced by FindRate(), and GetTypeId().

◆ m_pktLen

uint32_t ns3::MinstrelWifiManager::m_pktLen
private

packet length used for calculate mode TxTime

Definition at line 360 of file minstrel-wifi-manager.h.

Referenced by GetTypeId(), and SetupPhy().

◆ m_printSamples

bool ns3::MinstrelWifiManager::m_printSamples
private

whether samples table should be printed.

Definition at line 362 of file minstrel-wifi-manager.h.

Referenced by GetTypeId(), and UpdateStats().

◆ m_printStats

bool ns3::MinstrelWifiManager::m_printStats
private

whether statistics table should be printed.

Definition at line 361 of file minstrel-wifi-manager.h.

Referenced by GetTypeId(), and UpdateStats().

◆ m_sampleCol

uint8_t ns3::MinstrelWifiManager::m_sampleCol
private

number of sample columns

Definition at line 359 of file minstrel-wifi-manager.h.

Referenced by CheckInit(), GetNextSample(), GetTypeId(), InitSampleTable(), and PrintSampleTable().

◆ m_uniformRandomVariable

Ptr<UniformRandomVariable> ns3::MinstrelWifiManager::m_uniformRandomVariable
private

Provides uniform random variables.

Definition at line 365 of file minstrel-wifi-manager.h.

Referenced by AssignStreams(), InitSampleTable(), and MinstrelWifiManager().

◆ m_updateStats

Time ns3::MinstrelWifiManager::m_updateStats
private

how frequent do we calculate the stats (1/10 seconds)

Definition at line 356 of file minstrel-wifi-manager.h.

Referenced by DoCreateStation(), GetTypeId(), and UpdateStats().


The documentation for this class was generated from the following files: