Implementation of Minstrel-HT Rate Control Algorithm. More...

#include "minstrel-ht-wifi-manager.h"

Inheritance diagram for ns3::MinstrelHtWifiManager:

Collaboration diagram for ns3::MinstrelHtWifiManager:

Public Types
typedef void(*	RateChangeTracedCallback) (const uint64_t rate, const Mac48Address remoteAddress)
	TracedCallback signature for rate change events. More...

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...

using	Stations = std::unordered_map< Mac48Address, WifiRemoteStation *, WifiAddressHash >
	A map of WifiRemoteStations with Mac48Address as key. More...

using	StationStates = std::unordered_map< Mac48Address, WifiRemoteStationState *, WifiAddressHash >
	A map of WifiRemoteStationStates with Mac48Address as key. More...

Public Member Functions
	MinstrelHtWifiManager ()

virtual	~MinstrelHtWifiManager ()

int64_t	AssignStreams (int64_t stream) override
	Assign a fixed random variable stream number to the random variables used by this model. More...

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 parameters (e.g. More...

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 rates that are supported. 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	AddSupportedPhyPreamble (Mac48Address address, bool isShortPreambleSupported)
	Record whether the short PHY preamble is supported by the station. More...

WifiTxVector	GetAckTxVector (Mac48Address to, const WifiTxVector &dataTxVector) const
	Return a TXVECTOR for the Ack frame given the destination and the mode of the Data used by the sender. More...

uint16_t	GetAssociationId (Mac48Address remoteAddress) const
	Get the AID of a remote station. More...

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 to, const WifiTxVector &dataTxVector) const
	Return a TXVECTOR for the BlockAck frame given the destination and the mode of the Data used by the sender. More...

uint16_t	GetChannelWidthSupported (Mac48Address address) const
	Return the channel width supported by the station. More...

WifiMode	GetControlAnswerMode (WifiMode reqMode) const
	Get control answer mode function. More...

WifiTxVector	GetCtsToSelfTxVector (void)
	Since CTS-to-self parameters are not dependent on the station, it is implemented in wifi remote station manager. More...

WifiTxVector	GetCtsTxVector (Mac48Address to, WifiMode rtsTxMode) const
	Return a TXVECTOR for the CTS frame given the destination and the mode of the RTS used by the sender. More...

WifiTxVector	GetDataTxVector (const WifiMacHeader &header)

WifiMode	GetDefaultMcs (void) const
	Return the default Modulation and Coding Scheme (MCS) index. More...

WifiMode	GetDefaultMode (void) const
	Return the default transmission mode. More...

WifiMode	GetDefaultModeForSta (const WifiRemoteStation *st) const
	Return the default MCS to use to transmit frames to the given station. More...

uint8_t	GetDefaultTxPowerLevel (void) const

bool	GetDsssSupported (const Mac48Address &address) const
	Return whether the station supports DSSS or not. More...

bool	GetErpOfdmSupported (const Mac48Address &address) const
	Return whether the station supports ERP OFDM or not. More...

uint32_t	GetFragmentationThreshold (void) const
	Return the fragmentation threshold. More...

uint32_t	GetFragmentOffset (Ptr< const WifiMacQueueItem > mpdu, uint32_t fragmentNumber)

uint32_t	GetFragmentSize (Ptr< const WifiMacQueueItem > mpdu, uint32_t fragmentNumber)

uint16_t	GetGuardInterval (void) const
	Return the supported HE guard interval duration (in nanoseconds). More...

bool	GetHeSupported (Mac48Address address) const
	Return whether the station supports HE or not. More...

bool	GetHeSupported (void) const
	Return whether the device has HE capability support enabled. More...

bool	GetHtSupported (Mac48Address address) const
	Return whether the station supports HT or not. More...

bool	GetHtSupported (void) const
	Return whether the device has HT capability support enabled. More...

WifiRemoteStationInfo	GetInfo (Mac48Address address)

bool	GetLdpcSupported (Mac48Address address) const
	Return whether the station supports LDPC or not. More...

bool	GetLdpcSupported (void) const
	Return whether the device has LDPC support enabled. More...

Ptr< WifiMac >	GetMac (void) const
	Return the WifiMac. More...

uint8_t	GetMaxNumberOfTransmitStreams (void) const

double	GetMostRecentRssi (Mac48Address address) const

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) const

uint8_t	GetNumberOfSupportedStreams (Mac48Address address) const
	Return the number of spatial streams supported by the station. More...

bool	GetOfdmSupported (const Mac48Address &address) const
	Return whether the station supports OFDM or not. More...

Ptr< WifiPhy >	GetPhy (void) const
	Return the WifiPhy. More...

bool	GetQosSupported (Mac48Address address) const
	Return whether the given station is QoS capable. More...

WifiTxVector	GetRtsTxVector (Mac48Address address)

bool	GetShortGuardIntervalSupported (Mac48Address address) const
	Return whether the station supports HT/VHT short guard interval. More...

bool	GetShortGuardIntervalSupported (void) const
	Return whether the device has SGI support enabled. More...

bool	GetShortPreambleEnabled (void) const
	Return whether the device uses short PHY preambles. More...

bool	GetShortPreambleSupported (Mac48Address address) const
	Return whether the station supports short PHY 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...

Ptr< const HeCapabilities >	GetStationHeCapabilities (Mac48Address from)
	Return the HE capabilities sent by the remote station. More...

Ptr< const HtCapabilities >	GetStationHtCapabilities (Mac48Address from)
	Return the HT capabilities sent by the remote station. More...

Ptr< const VhtCapabilities >	GetStationVhtCapabilities (Mac48Address from)
	Return the VHT capabilities sent by the remote station. 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	GetVhtSupported (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 (Ptr< const WifiMacQueueItem > mpdu, 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 (Ptr< const WifiMacQueueItem > mpdu)

bool	NeedRetransmission (Ptr< const WifiMacQueueItem > mpdu)

bool	NeedRts (const WifiMacHeader &header, uint32_t size)

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, uint16_t nSuccessfulMpdus, uint16_t nFailedMpdus, double rxSnr, double dataSnr, WifiTxVector dataTxVector)
	Typically called per A-MPDU, either when a Block ACK was successfully received or when a BlockAckTimeout has elapsed. More...

void	ReportDataFailed (Ptr< const WifiMacQueueItem > mpdu)
	Should be invoked whenever the AckTimeout associated to a transmission attempt expires. More...

void	ReportDataOk (Ptr< const WifiMacQueueItem > mpdu, double ackSnr, WifiMode ackMode, double dataSnr, WifiTxVector dataTxVector)
	Should be invoked whenever we receive the ACK associated to a data packet we just sent. More...

void	ReportFinalDataFailed (Ptr< const WifiMacQueueItem > mpdu)
	Should be invoked after calling ReportDataFailed if NeedRetransmission returns false. More...

void	ReportFinalRtsFailed (const WifiMacHeader &header)
	Should be invoked after calling ReportRtsFailed if NeedRetransmission returns false. More...

void	ReportRtsFailed (const WifiMacHeader &header)
	Should be invoked whenever the RtsTimeout associated to a transmission attempt expires. More...

void	ReportRtsOk (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, RxSignalInfo rxSignalInfo, WifiTxVector txVector)

void	Reset (void)
	Reset the station, invoked in a STA upon dis-association or in an AP upon reboot. More...

void	SetAssociationId (Mac48Address remoteAddress, uint16_t aid)
	Record the AID of a remote station. 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...

void	SetQosSupport (Mac48Address from, bool qosSupported)
	Records QoS support of the remote station. More...

void	SetRtsCtsThreshold (uint32_t threshold)
	Sets the RTS threshold. More...

void	SetShortPreambleEnabled (bool enable)
	Enable or disable short PHY preambles. More...

void	SetShortSlotTimeEnabled (bool enable)
	Enable or disable short slot time. 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...

bool	UseLdpcForDestination (Mac48Address dest) const

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<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object. More...

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. More...

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object. More...

template<typename T >
Ptr< T >	GetObject (void) const
	Get a pointer to the requested aggregated Object. 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[[maybe_unused]])
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= ([[maybe_unused]] 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 Member Functions
void	AddFirstMpduTxTime (uint8_t groupId, WifiMode mode, Time t)
	Save a TxTime to the vector of groups. More...

void	AddMpduTxTime (uint8_t groupId, WifiMode mode, Time t)
	Save a TxTime to the vector of groups. More...

double	CalculateEwmsd (double oldEwmsd, double currentProb, double ewmaProb, double weight)
	Perform EWMSD (Exponentially Weighted Moving Standard Deviation) calculation. More...

Time	CalculateMpduTxDuration (Ptr< WifiPhy > phy, uint8_t streams, uint16_t gi, 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). More...

void	CalculateRetransmits (MinstrelHtWifiRemoteStation *station, uint16_t index)
	Calculate the number of retransmissions to set for the index rate. More...

void	CalculateRetransmits (MinstrelHtWifiRemoteStation *station, uint8_t groupId, uint8_t rateId)
	Calculate the number of retransmissions to set for the (groupId, rateId) rate. More...

double	CalculateThroughput (MinstrelHtWifiRemoteStation *station, uint8_t groupId, uint8_t rateId, double ewmaProb)
	Return the average throughput of the MCS defined by groupId and rateId. 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...

void	CheckInit (MinstrelHtWifiRemoteStation *station)
	Check for initializations. More...

uint32_t	CountRetries (MinstrelHtWifiRemoteStation *station)
	Count retries. More...

WifiRemoteStation *	DoCreateStation (void) const override

WifiTxVector	DoGetDataTxVector (WifiRemoteStation *station) override

WifiTxVector	DoGetRtsTxVector (WifiRemoteStation *station) override

void	DoInitialize (void) override
	Initialize() implementation. More...

bool	DoNeedRetransmission (WifiRemoteStation *st, Ptr< const Packet > packet, bool normally) override

void	DoReportAmpduTxStatus (WifiRemoteStation *station, uint16_t nSuccessfulMpdus, uint16_t nFailedMpdus, double rxSnr, double dataSnr, uint16_t dataChannelWidth, uint8_t dataNss) override
	Typically called per A-MPDU, either when a Block ACK was successfully received or when a BlockAckTimeout has elapsed. More...

void	DoReportDataFailed (WifiRemoteStation *station) override
	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, uint16_t dataChannelWidth, uint8_t dataNss) override
	This method is a pure virtual method that must be implemented by the sub-class. More...

void	DoReportFinalDataFailed (WifiRemoteStation *station) override
	This method is a pure virtual method that must be implemented by the sub-class. More...

void	DoReportFinalRtsFailed (WifiRemoteStation *station) override
	This method is a pure virtual method that must be implemented by the sub-class. More...

void	DoReportRtsFailed (WifiRemoteStation *station) override
	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) override
	This method is a pure virtual method that must be implemented by the sub-class. More...

void	DoReportRxOk (WifiRemoteStation *station, double rxSnr, WifiMode txMode) override
	This method is a pure virtual method that must be implemented by the sub-class. More...

uint16_t	FindRate (MinstrelHtWifiRemoteStation *station)
	Find a rate to use from Minstrel Table. More...

Time	GetFirstMpduTxTime (uint8_t groupId, WifiMode mode) const
	Obtain the TxTime saved in the group information. More...

uint8_t	GetGroupId (uint16_t index)
	Return the groupId from the global index. More...

WifiModeList	GetHeDeviceMcsList () const
	Returns a list of only the HE MCS supported by the device. More...

uint8_t	GetHeGroupId (uint8_t txstreams, uint16_t gi, uint16_t chWidth)
	Returns the groupId of an HE MCS with the given number of streams, GI and channel width used. More...

WifiModeList	GetHtDeviceMcsList (void) const
	Returns a list of only the HT MCS supported by the device. More...

uint8_t	GetHtGroupId (uint8_t txstreams, uint16_t gi, uint16_t chWidth)
	Returns the groupId of an HT MCS with the given number of streams, GI and channel width used. More...

uint16_t	GetIndex (uint8_t groupId, uint8_t rateId)
	Returns the global index corresponding to the groupId and rateId. More...

uint16_t	GetLowestIndex (MinstrelHtWifiRemoteStation *station)
	Returns the lowest global index of the rates supported by the station. More...

uint16_t	GetLowestIndex (MinstrelHtWifiRemoteStation *station, uint8_t groupId)
	Returns the lowest global index of the rates supported by in the group. More...

Time	GetMpduTxTime (uint8_t groupId, WifiMode mode) const
	Obtain the TxTime saved in the group information. More...

uint16_t	GetNextSample (MinstrelHtWifiRemoteStation *station)
	Getting the next sample from Sample Table. More...

uint8_t	GetRateId (uint16_t index)
	Return the rateId inside a group, from the global index. More...

WifiModeList	GetVhtDeviceMcsList (void) const
	Returns a list of only the VHT MCS supported by the device. More...

uint8_t	GetVhtGroupId (uint8_t txstreams, uint16_t gi, uint16_t chWidth)
	Returns the groupId of a VHT MCS with the given number of streams, GI and channel width used. More...

void	InitSampleTable (MinstrelHtWifiRemoteStation *station)
	Initialize Sample Table. More...

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. More...

void	PrintSampleTable (MinstrelHtWifiRemoteStation *station)
	Printing Sample Table. More...

void	PrintTable (MinstrelHtWifiRemoteStation *station)
	Printing Minstrel Table. More...

void	RateInit (MinstrelHtWifiRemoteStation *station)
	Initialize Minstrel Table. More...

void	SetBestProbabilityRate (MinstrelHtWifiRemoteStation *station, uint16_t index)
	Set index rate as maxProbRate if it is better than current value. More...

void	SetBestStationThRates (MinstrelHtWifiRemoteStation *station, uint16_t index)
	Set index rate as maxTpRate or maxTp2Rate if is better than current values. More...

void	SetNextSample (MinstrelHtWifiRemoteStation *station)
	Set the next sample from Sample Table. More...

void	StatsDump (MinstrelHtWifiRemoteStation *station, uint8_t groupId, std::ofstream &of)
	Print group statistics. More...

void	UpdatePacketCounters (MinstrelHtWifiRemoteStation *station, uint16_t nSuccessfulMpdus, uint16_t nFailedMpdus)
	Update the number of sample count variables. More...

void	UpdateRate (MinstrelHtWifiRemoteStation *station)
	Update rate. More...

void	UpdateRetry (MinstrelHtWifiRemoteStation *station)
	Update the number of retries and reset accordingly. More...

void	UpdateStats (MinstrelHtWifiRemoteStation *station)
	Update the Minstrel Table. More...

Private Attributes
TracedValue< uint64_t >	m_currentRate
	Trace rate changes. More...

uint8_t	m_ewmaLevel
	Exponential weighted moving average level (or coefficient). More...

uint32_t	m_frameLength
	Frame length used for calculate modes TxTime in bytes. More...

Ptr< MinstrelWifiManager >	m_legacyManager
	Pointer to an instance of MinstrelWifiManager. More...

Time	m_legacyUpdateStats
	How frequent do we calculate the stats for legacy MinstrelWifiManager. More...

uint8_t	m_lookAroundRate
	The % to try other rates than our current rate. More...

MinstrelMcsGroups	m_minstrelGroups
	Global array for groups information. More...

uint8_t	m_nSampleCol
	Number of sample columns. More...

uint8_t	m_numGroups
	Number of groups Minstrel should consider. More...

uint8_t	m_numRates
	Number of rates per group Minstrel should consider. More...

bool	m_printStats
	If statistics table should be printed. More...

Ptr< UniformRandomVariable >	m_uniformRandomVariable
	Provides uniform random variables. More...

Time	m_updateStats
	How frequent do we calculate the stats. More...

bool	m_useLatestAmendmentOnly
	Flag if only the latest supported amendment by both peers should be used. More...

Additional Inherited Members
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...

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...

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...

bool	GetQosSupported (const WifiRemoteStation *station) const
	Return whether the given station is QoS capable. More...

bool	GetShortGuardIntervalSupported (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	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...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

Implementation of Minstrel-HT Rate Control Algorithm.

Minstrel-HT is a rate adaptation mechanism for the 802.11n/ac/ax standards based on Minstrel, and is based on the approach of probing the channel to dynamically learn about working rates that can be supported. Minstrel-HT is designed for high-latency devices that implement a Multiple Rate Retry (MRR) chain. This kind of device does not give feedback for every frame retransmission, but only when a frame was correctly transmitted (an Ack is received) or a frame transmission completely fails (all retransmission attempts fail). The MRR chain is used to advise the hardware about which rate to use when retransmitting a frame.

Minstrel-HT adapts the MCS, channel width, number of streams, and short guard interval (enabled or disabled). For keeping statistics, it arranges MCS in groups, where each group is defined by the tuple (streams, GI, channel width). There is a vector of all groups supported by the PHY layer of the transmitter; for each group, the capabilities and the estimated duration of its rates are maintained.

Each station maintains a table of groups statistics. For each group, a flag indicates if the group is supported by the station. Different stations communicating with an AP can have different capabilities.

Stats are updated per A-MPDU when receiving AmpduTxStatus. If the number of successful or failed MPDUs is greater than zero (a BlockAck was received), the rates are also updated. If the number of successful and failed MPDUs is zero (BlockAck timeout), then the rate selected is based on the MRR chain.

On each update interval, it sets the maxThrRate, the secondmaxThrRate and the maxProbRate for the MRR chain. These rates are only used when an entire A-MPDU fails and is retried.

Differently from legacy minstrel, sampling is not done based on "lookaround ratio", but assuring all rates are sampled at least once each interval. However, it samples less often the low rates and high probability of error rates.

When this rate control is configured but non-legacy modes are not supported, Minstrel-HT uses legacy Minstrel (minstrel-wifi-manager) for rate control.

Config Paths

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

"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/RemoteStationManager/$ns3::MinstrelHtWifiManager"

Attributes

UpdateStatistics: The interval between updating statistics table
- Set with class: ns3::TimeValue
- Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
- Initial value: +5e+07ns
- Flags: construct write read
LegacyUpdateStatistics: The interval between updating statistics table (for legacy Minstrel)
- Set with class: ns3::TimeValue
- Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
- Initial value: +1e+08ns
- Flags: construct write read
LookAroundRate: The percentage to try other rates (for legacy Minstrel)
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:100
- Initial value: 10
- Flags: construct write read
EWMA: EWMA level
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:100
- Initial value: 75
- Flags: construct write read
SampleColumn: The number of columns used for sampling
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 10
- Flags: construct write read
PacketLength: The packet length used for calculating mode TxTime (bytes)
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 1200
- Flags: construct write read
UseLatestAmendmentOnly: Use only the latest amendment when it is supported by both peers
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: construct write read
PrintStats: Control the printing of the statistics table
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: construct write read

Attributes defined in parent class ns3::WifiRemoteStationManager

MaxSsrc: The maximum number of retransmission attempts for any packet with size <= RtsCtsThreshold. This value will not have any effect on some rate control algorithms.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 7
- Flags: construct write
MaxSlrc: The maximum number of retransmission attempts for any packet with size > RtsCtsThreshold. This value will not have any effect on some rate control algorithms.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 4
- Flags: construct write
RtsCtsThreshold: If the size of the PSDU is bigger than this value, we use an RTS/CTS handshake before sending the data frame.This value will not have any effect on some rate control algorithms.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 65535
- Flags: construct write
FragmentationThreshold: If the size of the PSDU is bigger than this value, we fragment it such that the size of the fragments are equal or smaller. This value does not apply when it is carried in an A-MPDU. This value will not have any effect on some rate control algorithms.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 65535
- Flags: construct write read
NonUnicastMode: Wifi mode used for non-unicast transmissions.
- Set with class: WifiModeValue
- Underlying type: WifiMode
- Initial value: Invalid-WifiMode
- Flags: construct write read
DefaultTxPowerLevel: Default power level to be used for transmissions. This is the power level that is used by all those WifiManagers that do not implement TX power control.
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 0
- Flags: construct write read
ErpProtectionMode: Protection mode used when non-ERP STAs are connected to an ERP AP: Rts-Cts or Cts-To-Self
- Set with class: ns3::EnumValue
- Underlying type:
- Initial value: Cts-To-Self
- Flags: construct write read
HtProtectionMode: Protection mode used when non-HT STAs are connected to a HT AP: Rts-Cts or Cts-To-Self
- Set with class: ns3::EnumValue
- Underlying type:
- Initial value: Cts-To-Self
- Flags: construct write read

TraceSources

Rate: Traced value for rate changes (b/s)
Callback signature: ns3::TracedValueCallback::Uint64

TraceSources defined in parent class ns3::WifiRemoteStationManager

MacTxRtsFailed: The transmission of a RTS by the MAC layer has failed
Callback signature: ns3::Mac48Address::TracedCallback
MacTxDataFailed: The transmission of a data packet by the MAC layer has failed
Callback signature: ns3::Mac48Address::TracedCallback
MacTxFinalRtsFailed: The transmission of a RTS has exceeded the maximum number of attempts
Callback signature: ns3::Mac48Address::TracedCallback
MacTxFinalDataFailed: The transmission of a data packet has exceeded the maximum number of attempts
Callback signature: ns3::Mac48Address::TracedCallback

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

Definition at line 222 of file minstrel-ht-wifi-manager.h.

Member Typedef Documentation

◆ RateChangeTracedCallback

typedef void(* ns3::MinstrelHtWifiManager::RateChangeTracedCallback) (const uint64_t rate, const Mac48Address remoteAddress)

TracedCallback signature for rate change events.

Parameters

[in]	rate	The new rate.
[in]	address	The remote station MAC address.

Definition at line 243 of file minstrel-ht-wifi-manager.h.

Constructor & Destructor Documentation

◆ MinstrelHtWifiManager()

ns3::MinstrelHtWifiManager::MinstrelHtWifiManager ( )

Create the legacy Minstrel manager in case HT is not supported by the device or non-HT stations want to associate.

Definition at line 130 of file minstrel-ht-wifi-manager.cc.

References m_legacyManager, m_uniformRandomVariable, and NS_LOG_FUNCTION.

◆ ~MinstrelHtWifiManager()

ns3::MinstrelHtWifiManager::~MinstrelHtWifiManager ( )

virtual

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

References m_minstrelGroups, m_numGroups, and NS_LOG_FUNCTION.

Member Function Documentation

◆ AddFirstMpduTxTime()

void ns3::MinstrelHtWifiManager::AddFirstMpduTxTime	(	uint8_t	groupId,
		WifiMode	mode,
		Time	t
	)

private

Save a TxTime to the vector of groups.

Parameters

groupId	the group ID
mode	the wifi mode
t	the transmit time

Definition at line 386 of file minstrel-ht-wifi-manager.cc.

References m_minstrelGroups, and NS_LOG_FUNCTION.

Referenced by DoInitialize().

Here is the caller graph for this function:

◆ AddMpduTxTime()

void ns3::MinstrelHtWifiManager::AddMpduTxTime	(	uint8_t	groupId,
		WifiMode	mode,
		Time	t
	)

private

Save a TxTime to the vector of groups.

Parameters

groupId	the group ID
mode	the wifi mode
t	the transmit time

Definition at line 402 of file minstrel-ht-wifi-manager.cc.

References m_minstrelGroups, and NS_LOG_FUNCTION.

Referenced by DoInitialize().

Here is the caller graph for this function:

◆ AssignStreams()

int64_t ns3::MinstrelHtWifiManager::AssignStreams ( int64_t stream )

overridevirtual

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

stream first stream index to use

Returns: the number of stream indices assigned by this model

Reimplemented from ns3::WifiRemoteStationManager.

Definition at line 155 of file minstrel-ht-wifi-manager.cc.

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

Here is the call graph for this function:

◆ CalculateEwmsd()

double ns3::MinstrelHtWifiManager::CalculateEwmsd	(	double	oldEwmsd,
		double	currentProb,
		double	ewmaProb,
		double	weight
	)

private

Perform EWMSD (Exponentially Weighted Moving Standard Deviation) calculation.

Parameters

oldEwmsd	the old EWMSD
currentProb	the current probability
ewmaProb	the EWMA probability
weight	the weight

Returns: the EWMSD

Definition at line 1665 of file minstrel-ht-wifi-manager.cc.

Referenced by UpdateStats().

Here is the caller graph for this function:

◆ CalculateMpduTxDuration()

Time ns3::MinstrelHtWifiManager::CalculateMpduTxDuration	(	Ptr< WifiPhy >	phy,
		uint8_t	streams,
		uint16_t	gi,
		uint16_t	chWidth,
		WifiMode	mode,
		MpduType	mpduType
	)

private

Estimates the TxTime of a frame with a given mode and group (stream, guard interval and channel width).

Parameters

phy	pointer to the wifi PHY
streams	the number of streams
gi	guard interval duration (nanoseconds)
chWidth	the channel width (MHz)
mode	the wifi mode
mpduType	the type of the MPDU

Returns: the transmit time

Definition at line 360 of file minstrel-ht-wifi-manager.cc.

References ns3::WifiPhy::CalculatePhyPreambleAndHeaderDuration(), ns3::WifiPhy::GetPayloadDuration(), m_frameLength, NS_LOG_FUNCTION, third::phy, ns3::WifiTxVector::SetChannelWidth(), ns3::WifiTxVector::SetGuardInterval(), ns3::WifiTxVector::SetMode(), ns3::WifiTxVector::SetNess(), ns3::WifiTxVector::SetNss(), ns3::WifiTxVector::SetPreambleType(), ns3::WifiTxVector::SetStbc(), and ns3::WIFI_PREAMBLE_HT_MF.

Referenced by DoInitialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CalculateRetransmits() [1/2]

void ns3::MinstrelHtWifiManager::CalculateRetransmits	(	MinstrelHtWifiRemoteStation *	station,
		uint16_t	index
	)

private

Calculate the number of retransmissions to set for the index rate.

Parameters

station	the Minstrel-HT wifi remote station
index	the index

Definition at line 1606 of file minstrel-ht-wifi-manager.cc.

References GetGroupId(), GetRateId(), ns3::MinstrelHtWifiRemoteStation::m_groupsTable, and NS_LOG_FUNCTION.

Referenced by RateInit(), and UpdateStats().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CalculateRetransmits() [2/2]

void ns3::MinstrelHtWifiManager::CalculateRetransmits	(	MinstrelHtWifiRemoteStation *	station,
		uint8_t	groupId,
		uint8_t	rateId
	)

private

Calculate the number of retransmissions to set for the (groupId, rateId) rate.

Parameters

station	the Minstrel-HT wifi remote station
groupId	the group ID
rateId	the rate ID

Definition at line 1618 of file minstrel-ht-wifi-manager.cc.

References ns3::WifiPhy::GetBlockAckTxTime(), GetFirstMpduTxTime(), ns3::WifiRemoteStationManager::GetMcsSupported(), GetMpduTxTime(), ns3::WifiRemoteStationManager::GetPhy(), ns3::WifiPhy::GetSifs(), ns3::WifiPhy::GetSlot(), ns3::MinstrelHtWifiRemoteStation::m_avgAmpduLen, ns3::MinstrelHtWifiRemoteStation::m_groupsTable, ns3::MilliSeconds(), ns3::Min(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ CalculateThroughput()

double ns3::MinstrelHtWifiManager::CalculateThroughput	(	MinstrelHtWifiRemoteStation *	station,
		uint8_t	groupId,
		uint8_t	rateId,
		double	ewmaProb
	)

private

Return the average throughput of the MCS defined by groupId and rateId.

Parameters

station	the Minstrel-HT wifi remote station
groupId	the group ID
rateId	the rate ID
ewmaProb	the EWMA probability

Returns: the throughput in bps

Calculating throughput. Do not account throughput if probability of success is below 10% (as done in minstrel_ht linux implementation).

For the throughput calculation, limit the probability value to 90% to account for collision related packet error rate fluctuation.

Definition at line 1323 of file minstrel-ht-wifi-manager.cc.

References ns3::Time::GetSeconds(), and ns3::MinstrelHtWifiRemoteStation::m_groupsTable.

Referenced by StatsDump(), and UpdateStats().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CalculateTimeUnicastPacket()

Time ns3::MinstrelHtWifiManager::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

dataTransmissionTime	the data transmission time
shortRetries	the short retries
longRetries	the long retries

Returns: the unicast packet time

◆ CheckInit()

void ns3::MinstrelHtWifiManager::CheckInit ( MinstrelHtWifiRemoteStation * station )

private

Check for initializations.

Parameters

station the Minstrel-HT wifi remote station

Check if the station supports HT. Assume that if the device do not supports HT then the station will not support HT either. We save from using another check and variable.

Definition at line 462 of file minstrel-ht-wifi-manager.cc.

References ns3::WifiRemoteStationManager::GetHtSupported(), ns3::WifiRemoteStationManager::GetNMcsSupported(), InitSampleTable(), m_ewmaLevel, m_frameLength, ns3::MinstrelWifiRemoteStation::m_initialized, ns3::MinstrelHtWifiRemoteStation::m_isHt, m_legacyManager, m_legacyUpdateStats, m_lookAroundRate, ns3::MinstrelWifiRemoteStation::m_minstrelTable, ns3::MinstrelWifiRemoteStation::m_nModes, m_nSampleCol, m_numRates, m_printStats, ns3::MinstrelWifiRemoteStation::m_sampleTable, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_INFO, and RateInit().

Referenced by DoGetDataTxVector(), DoGetRtsTxVector(), DoNeedRetransmission(), DoReportAmpduTxStatus(), DoReportDataFailed(), DoReportDataOk(), DoReportFinalDataFailed(), DoReportFinalRtsFailed(), DoReportRtsFailed(), and UpdateRate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CountRetries()

uint32_t ns3::MinstrelHtWifiManager::CountRetries ( MinstrelHtWifiRemoteStation * station )

private

Count retries.

Parameters

station the Minstrel-HT wifi remote station

Returns: the count of retries

Definition at line 1034 of file minstrel-ht-wifi-manager.cc.

References GetGroupId(), GetRateId(), ns3::MinstrelHtWifiRemoteStation::m_groupsTable, ns3::MinstrelWifiRemoteStation::m_isSampling, ns3::MinstrelWifiRemoteStation::m_maxProbRate, ns3::MinstrelWifiRemoteStation::m_maxTpRate, and ns3::MinstrelWifiRemoteStation::m_maxTpRate2.

Referenced by DoNeedRetransmission(), DoReportAmpduTxStatus(), and DoReportDataFailed().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoCreateStation()

WifiRemoteStation * ns3::MinstrelHtWifiManager::DoCreateStation ( void ) const

overrideprivatevirtual

Returns: a new station data structure

Assume the station is HT. When correct information available it will be checked.

Implements ns3::WifiRemoteStationManager.

Definition at line 409 of file minstrel-ht-wifi-manager.cc.

Here is the call graph for this function:

◆ DoGetDataTxVector()

WifiTxVector ns3::MinstrelHtWifiManager::DoGetDataTxVector ( WifiRemoteStation * station )

overrideprivatevirtual

Parameters

station the 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 865 of file minstrel-ht-wifi-manager.cc.

Here is the call graph for this function:

◆ DoGetRtsTxVector()

WifiTxVector ns3::MinstrelHtWifiManager::DoGetRtsTxVector ( WifiRemoteStation * station )

overrideprivatevirtual

Parameters

station the 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 923 of file minstrel-ht-wifi-manager.cc.

Here is the call graph for this function:

◆ DoInitialize()

void ns3::MinstrelHtWifiManager::DoInitialize ( void )

overrideprivatevirtual

Initialize() implementation.

This method is called only once by Initialize(). If the user calls Initialize() multiple times, DoInitialize() is called only the first time.

Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject() and AggregateObject() from within this method.

Here we initialize m_minstrelGroups with all the possible groups. If a group is not supported by the device, then it is marked as not supported. Then, after all initializations are finished, we check actual support for each receiving station.

Initialize the groups array. The HT groups come first, then the VHT ones, and finally the HE ones. Minstrel maintains different types of indexes:

A global continuous index, which identifies all rates within all groups, in [0, m_numGroups * m_numRates]
A groupId, which indexes a group in the array, in [0, m_numGroups]
A rateId, which identifies a rate within a group, in [0, m_numRates]
A deviceIndex, which indexes a MCS in the PHY MCS array.
A mcsIndex, which indexes a MCS in the wifi-remote-station-manager supported MCSs array.

Is SGI supported by the transmitter?

Is channel width supported by the transmitter?

Are streams supported by the transmitter?

Is SGI supported by the transmitter?

Is channel width supported by the transmitter?

Are streams supported by the transmitter?

Is GI supported by the transmitter?

Is channel width supported by the transmitter?

Are streams supported by the transmitter?

Reimplemented from ns3::Object.

Definition at line 183 of file minstrel-ht-wifi-manager.cc.

References AddFirstMpduTxTime(), AddMpduTxTime(), CalculateMpduTxDuration(), ns3::FIRST_MPDU_IN_AGGREGATE, ns3::WifiRemoteStationManager::GetChannelWidth(), ns3::WifiRemoteStationManager::GetGuardInterval(), GetHeDeviceMcsList(), GetHeGroupId(), ns3::WifiRemoteStationManager::GetHeSupported(), GetHtDeviceMcsList(), GetHtGroupId(), ns3::WifiRemoteStationManager::GetHtSupported(), ns3::WifiRemoteStationManager::GetPhy(), ns3::WifiRemoteStationManager::GetShortGuardIntervalSupported(), GetVhtDeviceMcsList(), GetVhtGroupId(), ns3::WifiRemoteStationManager::GetVhtSupported(), ns3::GROUP_HE, ns3::GROUP_HT, ns3::GROUP_VHT, IsValidMcs(), m_minstrelGroups, m_numGroups, m_numRates, ns3::MAX_HE_GROUP_RATES, ns3::MAX_HE_STREAM_GROUPS, ns3::MAX_HE_SUPPORTED_STREAMS, ns3::MAX_HE_WIDTH, ns3::MAX_HT_GROUP_RATES, ns3::MAX_HT_STREAM_GROUPS, ns3::MAX_HT_SUPPORTED_STREAMS, ns3::MAX_HT_WIDTH, ns3::MAX_VHT_GROUP_RATES, ns3::MAX_VHT_STREAM_GROUPS, ns3::MAX_VHT_SUPPORTED_STREAMS, ns3::MAX_VHT_WIDTH, ns3::MIDDLE_MPDU_IN_AGGREGATE, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ DoNeedRetransmission()

bool ns3::MinstrelHtWifiManager::DoNeedRetransmission	(	WifiRemoteStation *	station,
		Ptr< const Packet >	packet,
		bool	normally
	)

overrideprivatevirtual

Parameters

station	the station that we need to communicate
packet	the packet to send
normally	indicates 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 998 of file minstrel-ht-wifi-manager.cc.

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

Here is the call graph for this function:

◆ DoReportAmpduTxStatus()

void ns3::MinstrelHtWifiManager::DoReportAmpduTxStatus	(	WifiRemoteStation *	station,
		uint16_t	nSuccessfulMpdus,
		uint16_t	nFailedMpdus,
		double	rxSnr,
		double	dataSnr,
		uint16_t	dataChannelWidth,
		uint8_t	dataNss
	)

overrideprivatevirtual

Typically called per A-MPDU, either when a Block ACK was successfully received or when a BlockAckTimeout has elapsed.

This method is a virtual method that must be implemented by the sub-class intended to handle A-MPDUs. This allows different types of WifiRemoteStationManager to respond differently.

Parameters

station	the station that sent the DATA to us
nSuccessfulMpdus	number of successfully transmitted MPDUs. A value of 0 means that the Block ACK was missed.
nFailedMpdus	number of unsuccessfully transmitted MPDUs.
rxSnr	received SNR of the block ack frame itself
dataSnr	data SNR reported by remote station
dataChannelWidth	the channel width (in MHz) of the A-MPDU we sent
dataNss	the number of spatial streams used to send the A-MPDU

Reimplemented from ns3::WifiRemoteStationManager.

Definition at line 680 of file minstrel-ht-wifi-manager.cc.

Here is the call graph for this function:

◆ DoReportDataFailed()

void ns3::MinstrelHtWifiManager::DoReportDataFailed ( WifiRemoteStation * station )

overrideprivatevirtual

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

station the station that we failed to send DATA

Implements ns3::WifiRemoteStationManager.

Definition at line 545 of file minstrel-ht-wifi-manager.cc.

References CheckInit(), CountRetries(), GetGroupId(), GetRateId(), ns3::MinstrelHtWifiRemoteStation::m_groupsTable, ns3::MinstrelWifiRemoteStation::m_initialized, ns3::MinstrelHtWifiRemoteStation::m_isHt, m_legacyManager, ns3::MinstrelWifiRemoteStation::m_longRetry, ns3::MinstrelWifiRemoteStation::m_txrate, NS_LOG_DEBUG, NS_LOG_FUNCTION, and UpdateRate().

Here is the call graph for this function:

◆ DoReportDataOk()

void ns3::MinstrelHtWifiManager::DoReportDataOk	(	WifiRemoteStation *	station,
		double	ackSnr,
		WifiMode	ackMode,
		double	dataSnr,
		uint16_t	dataChannelWidth,
		uint8_t	dataNss
	)

overrideprivatevirtual

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

station	the station that we successfully sent RTS
ackSnr	the SNR of the ACK we received
ackMode	the WifiMode the receiver used to send the ACK
dataSnr	the SNR of the DATA we sent
dataChannelWidth	the channel width (in MHz) of the DATA we sent
dataNss	the number of spatial streams used to send the DATA

Implements ns3::WifiRemoteStationManager.

Definition at line 572 of file minstrel-ht-wifi-manager.cc.

Here is the call graph for this function:

◆ DoReportFinalDataFailed()

void ns3::MinstrelHtWifiManager::DoReportFinalDataFailed ( WifiRemoteStation * station )

overrideprivatevirtual

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

station the station that we failed to send DATA

Implements ns3::WifiRemoteStationManager.

Definition at line 633 of file minstrel-ht-wifi-manager.cc.

References CheckInit(), FindRate(), ns3::MinstrelWifiRemoteStation::m_initialized, ns3::MinstrelHtWifiRemoteStation::m_isHt, ns3::MinstrelWifiRemoteStation::m_isSampling, m_legacyManager, ns3::MinstrelWifiRemoteStation::m_nextStatsUpdate, ns3::MinstrelWifiRemoteStation::m_nModes, ns3::MinstrelWifiRemoteStation::m_sampleDeferred, ns3::MinstrelWifiRemoteStation::m_txrate, ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, UpdatePacketCounters(), UpdateRetry(), and UpdateStats().

Here is the call graph for this function:

◆ DoReportFinalRtsFailed()

void ns3::MinstrelHtWifiManager::DoReportFinalRtsFailed ( WifiRemoteStation * station )

overrideprivatevirtual

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

station the station that we failed to send RTS

Implements ns3::WifiRemoteStationManager.

Definition at line 531 of file minstrel-ht-wifi-manager.cc.

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

Here is the call graph for this function:

◆ DoReportRtsFailed()

void ns3::MinstrelHtWifiManager::DoReportRtsFailed ( WifiRemoteStation * station )

overrideprivatevirtual

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

station the station that we failed to send RTS

Implements ns3::WifiRemoteStationManager.

Definition at line 511 of file minstrel-ht-wifi-manager.cc.

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

Here is the call graph for this function:

◆ DoReportRtsOk()

void ns3::MinstrelHtWifiManager::DoReportRtsOk	(	WifiRemoteStation *	station,
		double	ctsSnr,
		WifiMode	ctsMode,
		double	rtsSnr
	)

overrideprivatevirtual

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

station	the station that we successfully sent RTS
ctsSnr	the SNR of the CTS we received
ctsMode	the WifiMode the receiver used to send the CTS
rtsSnr	the SNR of the RTS we sent

Implements ns3::WifiRemoteStationManager.

Definition at line 525 of file minstrel-ht-wifi-manager.cc.

References NS_LOG_FUNCTION.

◆ DoReportRxOk()

void ns3::MinstrelHtWifiManager::DoReportRxOk	(	WifiRemoteStation *	station,
		double	rxSnr,
		WifiMode	txMode
	)

overrideprivatevirtual

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

station	the station that sent the DATA to us
rxSnr	the SNR of the DATA we received
txMode	the WifiMode the sender used to send the DATA

Implements ns3::WifiRemoteStationManager.

Definition at line 504 of file minstrel-ht-wifi-manager.cc.

References NS_LOG_DEBUG, and NS_LOG_FUNCTION.

◆ FindRate()

uint16_t ns3::MinstrelHtWifiManager::FindRate ( MinstrelHtWifiRemoteStation * station )

private

Find a rate to use from Minstrel Table.

Parameters

station the Minstrel-HT wifi remote station

Returns: the rate in bps

Now go through the table and find an index rate.

Sampling might add some overhead to the frame. Hence, don't use sampling for the currently used rates.

Also do not sample if the probability is already higher than 95% to avoid wasting airtime.

Make sure that lower rates get sampled only occasionally, if the link is working perfectly.

Set flag that we are currently sampling.

set the rate that we're currently sampling

Set flag that we are currently sampling.

set the rate that we're currently sampling

Continue using the best rate.

Definition at line 1102 of file minstrel-ht-wifi-manager.cc.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetFirstMpduTxTime()

Time ns3::MinstrelHtWifiManager::GetFirstMpduTxTime	(	uint8_t	groupId,
		WifiMode	mode
	)		const

private

Obtain the TxTime saved in the group information.

Parameters

groupId	the group ID
mode	the wifi mode

Returns: the transmit time

Definition at line 377 of file minstrel-ht-wifi-manager.cc.

References m_minstrelGroups, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by CalculateRetransmits(), RateInit(), and StatsDump().

Here is the caller graph for this function:

◆ GetGroupId()

uint8_t ns3::MinstrelHtWifiManager::GetGroupId ( uint16_t index )

private

Return the groupId from the global index.

Parameters

index the index

Returns: the group ID

Definition at line 1823 of file minstrel-ht-wifi-manager.cc.

References m_numRates, and NS_LOG_FUNCTION.

Referenced by CalculateRetransmits(), CountRetries(), DoGetDataTxVector(), DoGetRtsTxVector(), DoReportAmpduTxStatus(), DoReportDataFailed(), DoReportDataOk(), FindRate(), SetBestProbabilityRate(), SetBestStationThRates(), and UpdateRate().

Here is the caller graph for this function:

◆ GetHeDeviceMcsList()

WifiModeList ns3::MinstrelHtWifiManager::GetHeDeviceMcsList ( ) const

private

Returns a list of only the HE MCS supported by the device.

Returns: the list of the HE MCS supported

Definition at line 1942 of file minstrel-ht-wifi-manager.cc.

References ns3::WifiRemoteStationManager::GetPhy(), and ns3::WIFI_MOD_CLASS_HE.

Referenced by DoInitialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetHeGroupId()

uint8_t ns3::MinstrelHtWifiManager::GetHeGroupId	(	uint8_t	txstreams,
		uint16_t	gi,
		uint16_t	chWidth
	)

private

Returns the groupId of an HE MCS with the given number of streams, GI and channel width used.

Parameters

txstreams	the number of streams
gi	guard interval duration (nanoseconds)
chWidth	the channel width (MHz)

Returns: the HE group ID

add all HT groups

This check is needed since we do not support VHT in 2.4 GHz band

add all VHT groups

Definition at line 1866 of file minstrel-ht-wifi-manager.cc.

References ns3::WifiRemoteStationManager::GetVhtSupported(), ns3::MAX_HE_SUPPORTED_STREAMS, ns3::MAX_HT_STREAM_GROUPS, ns3::MAX_HT_SUPPORTED_STREAMS, ns3::MAX_VHT_STREAM_GROUPS, ns3::MAX_VHT_SUPPORTED_STREAMS, and NS_LOG_FUNCTION.

Referenced by DoInitialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetHtDeviceMcsList()

WifiModeList ns3::MinstrelHtWifiManager::GetHtDeviceMcsList ( void ) const

private

Returns a list of only the HT MCS supported by the device.

Returns: the list of the HT MCS supported

Definition at line 1964 of file minstrel-ht-wifi-manager.cc.

References ns3::WifiRemoteStationManager::GetPhy(), and ns3::WIFI_MOD_CLASS_HT.

Referenced by DoInitialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetHtGroupId()

uint8_t ns3::MinstrelHtWifiManager::GetHtGroupId	(	uint8_t	txstreams,
		uint16_t	gi,
		uint16_t	chWidth
	)

private

Returns the groupId of an HT MCS with the given number of streams, GI and channel width used.

Parameters

txstreams	the number of streams
gi	guard interval duration (nanoseconds)
chWidth	the channel width (MHz)

Returns: the HT group ID

Definition at line 1830 of file minstrel-ht-wifi-manager.cc.

References ns3::MAX_HT_SUPPORTED_STREAMS, and NS_LOG_FUNCTION.

Referenced by DoInitialize().

Here is the caller graph for this function:

◆ GetIndex()

uint16_t ns3::MinstrelHtWifiManager::GetIndex	(	uint8_t	groupId,
		uint8_t	rateId
	)

private

Returns the global index corresponding to the groupId and rateId.

For managing rates from different groups, a global index for all rates in all groups is used. The group order is fixed by BW -> SGI -> streams.

Parameters

groupId	the group ID
rateId	the rate ID

Returns: the index

Definition at line 1805 of file minstrel-ht-wifi-manager.cc.

References m_numRates, and NS_LOG_FUNCTION.

Referenced by GetLowestIndex(), GetNextSample(), StatsDump(), and UpdateStats().

Here is the caller graph for this function:

◆ GetLowestIndex() [1/2]

uint16_t ns3::MinstrelHtWifiManager::GetLowestIndex ( MinstrelHtWifiRemoteStation * station )

private

Returns the lowest global index of the rates supported by the station.

Parameters

station the Minstrel-HT wifi remote station

Returns: the lowest global index

Definition at line 1909 of file minstrel-ht-wifi-manager.cc.

References GetIndex(), ns3::MinstrelHtWifiRemoteStation::m_groupsTable, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by UpdateStats().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetLowestIndex() [2/2]

uint16_t ns3::MinstrelHtWifiManager::GetLowestIndex	(	MinstrelHtWifiRemoteStation *	station,
		uint8_t	groupId
	)

private

Returns the lowest global index of the rates supported by in the group.

Parameters

station	the Minstrel-HT wifi remote station
groupId	the group ID

Returns: the lowest global index

Definition at line 1928 of file minstrel-ht-wifi-manager.cc.

References GetIndex(), ns3::MinstrelHtWifiRemoteStation::m_groupsTable, NS_ASSERT, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ GetMpduTxTime()

Time ns3::MinstrelHtWifiManager::GetMpduTxTime	(	uint8_t	groupId,
		WifiMode	mode
	)		const

private

Obtain the TxTime saved in the group information.

Parameters

groupId	the group ID
mode	the wifi mode

Returns: the transmit time

Definition at line 393 of file minstrel-ht-wifi-manager.cc.

References m_minstrelGroups, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by CalculateRetransmits().

Here is the caller graph for this function:

◆ GetNextSample()

uint16_t ns3::MinstrelHtWifiManager::GetNextSample ( MinstrelHtWifiRemoteStation * station )

private

Getting the next sample from Sample Table.

Parameters

station the wifi remote station

Returns: the next sample

Definition at line 1057 of file minstrel-ht-wifi-manager.cc.

References GetIndex(), ns3::MinstrelHtWifiRemoteStation::m_groupsTable, ns3::MinstrelHtWifiRemoteStation::m_sampleGroup, ns3::MinstrelWifiRemoteStation::m_sampleTable, NS_LOG_DEBUG, NS_LOG_FUNCTION, and SetNextSample().

Referenced by FindRate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetRateId()

uint8_t ns3::MinstrelHtWifiManager::GetRateId ( uint16_t index )

private

Return the rateId inside a group, from the global index.

Parameters

index the index

Returns: the rate ID

Definition at line 1814 of file minstrel-ht-wifi-manager.cc.

References m_numRates, and NS_LOG_FUNCTION.

Referenced by CalculateRetransmits(), CountRetries(), DoGetDataTxVector(), DoGetRtsTxVector(), DoReportAmpduTxStatus(), DoReportDataFailed(), DoReportDataOk(), FindRate(), SetBestProbabilityRate(), SetBestStationThRates(), and UpdateRate().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::MinstrelHtWifiManager::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 76 of file minstrel-ht-wifi-manager.cc.

References m_currentRate, m_ewmaLevel, m_frameLength, m_legacyUpdateStats, m_lookAroundRate, m_nSampleCol, m_printStats, m_updateStats, m_useLatestAmendmentOnly, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeTraceSourceAccessor(), ns3::MakeUintegerAccessor(), ns3::MilliSeconds(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ GetVhtDeviceMcsList()

WifiModeList ns3::MinstrelHtWifiManager::GetVhtDeviceMcsList ( void ) const

private

Returns a list of only the VHT MCS supported by the device.

Returns: the list of the VHT MCS supported

Definition at line 1953 of file minstrel-ht-wifi-manager.cc.

References ns3::WifiRemoteStationManager::GetPhy(), and ns3::WIFI_MOD_CLASS_VHT.

Referenced by DoInitialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetVhtGroupId()

uint8_t ns3::MinstrelHtWifiManager::GetVhtGroupId	(	uint8_t	txstreams,
		uint16_t	gi,
		uint16_t	chWidth
	)

private

Returns the groupId of a VHT MCS with the given number of streams, GI and channel width used.

Parameters

txstreams	the number of streams
gi	guard interval duration (nanoseconds)
chWidth	the channel width (MHz)

Returns: the VHT group ID

add all HT groups

Definition at line 1839 of file minstrel-ht-wifi-manager.cc.

References ns3::MAX_HT_STREAM_GROUPS, ns3::MAX_HT_SUPPORTED_STREAMS, ns3::MAX_VHT_SUPPORTED_STREAMS, and NS_LOG_FUNCTION.

Referenced by DoInitialize().

Here is the caller graph for this function:

◆ InitSampleTable()

void ns3::MinstrelHtWifiManager::InitSampleTable ( MinstrelHtWifiRemoteStation * station )

private

Initialize Sample Table.

Parameters

station the Minstrel-HT wifi remote station

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

Definition at line 1680 of file minstrel-ht-wifi-manager.cc.

References ns3::UniformRandomVariable::GetInteger(), ns3::MinstrelWifiRemoteStation::m_col, ns3::MinstrelWifiRemoteStation::m_index, m_nSampleCol, m_numRates, ns3::MinstrelWifiRemoteStation::m_sampleTable, m_uniformRandomVariable, and NS_LOG_FUNCTION.

Referenced by CheckInit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsValidMcs()

bool ns3::MinstrelHtWifiManager::IsValidMcs	(	Ptr< WifiPhy >	phy,
		uint8_t	streams,
		uint16_t	chWidth,
		WifiMode	mode
	)

private

Check the validity of a combination of number of streams, chWidth and mode.

Parameters

phy	pointer to the wifi PHY
streams	the number of streams
chWidth	the channel width (MHz)
mode	the wifi mode

Returns: true if the combination is valid

Definition at line 349 of file minstrel-ht-wifi-manager.cc.

References ns3::WifiTxVector::IsValid(), NS_LOG_FUNCTION, third::phy, ns3::WifiTxVector::SetChannelWidth(), ns3::WifiTxVector::SetMode(), and ns3::WifiTxVector::SetNss().

Referenced by DoInitialize(), and RateInit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PrintSampleTable()

void ns3::MinstrelHtWifiManager::PrintSampleTable ( MinstrelHtWifiRemoteStation * station )

private

Printing Sample Table.

Parameters

station the Minstrel-HT wifi remote station

◆ PrintTable()

void ns3::MinstrelHtWifiManager::PrintTable ( MinstrelHtWifiRemoteStation * station )

private

Printing Minstrel Table.

Parameters

station the Minstrel-HT wifi remote station

Definition at line 1711 of file minstrel-ht-wifi-manager.cc.

References ns3::WifiRemoteStationState::m_address, ns3::MinstrelHtWifiRemoteStation::m_avgAmpduLen, m_numGroups, ns3::MinstrelWifiRemoteStation::m_samplePacketsCount, ns3::WifiRemoteStation::m_state, ns3::MinstrelHtWifiRemoteStation::m_statsFile, ns3::MinstrelWifiRemoteStation::m_totalPacketsCount, ns3::Max(), and StatsDump().

Referenced by UpdateStats().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RateInit()

void ns3::MinstrelHtWifiManager::RateInit ( MinstrelHtWifiRemoteStation * station )

private

Initialize Minstrel Table.

Parameters

station the Minstrel-HT wifi remote station

Initialize groups supported by the receiver.

Create the rate list for the group.

Use the McsValue as the index in the rate table. This way, MCSs not supported are not initialized.

If it is a HE MCS only add to a HE group.

Check validity of the HE MCS

If it is a VHT MCS only add to a VHT group.

Check validity of the VHT MCS

If it is a HT MCS only add to a HT group.

Check if the HT MCS corresponds to groups number of streams.

Mapping between rateId and operationalMcsSet

make sure at least one group is supported, otherwise we end up with an infinite loop in SetNextSample

Select the initial sample index.

Calculate the initial high throughput rates.

Select the rate to use.

Definition at line 1473 of file minstrel-ht-wifi-manager.cc.

Referenced by CheckInit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetBestProbabilityRate()

void ns3::MinstrelHtWifiManager::SetBestProbabilityRate	(	MinstrelHtWifiRemoteStation *	station,
		uint16_t	index
	)

private

Set index rate as maxProbRate if it is better than current value.

Parameters

station	the Minstrel-HT wifi remote station
index	the index

Definition at line 1353 of file minstrel-ht-wifi-manager.cc.

References ns3::MinstrelHtRateInfo::ewmaProb, GetGroupId(), GetRateId(), ns3::MinstrelHtWifiRemoteStation::m_groupsTable, ns3::GroupInfo::m_maxProbRate, ns3::MinstrelWifiRemoteStation::m_maxProbRate, and ns3::GroupInfo::m_ratesTable.

Referenced by UpdateStats().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetBestStationThRates()

void ns3::MinstrelHtWifiManager::SetBestStationThRates	(	MinstrelHtWifiRemoteStation *	station,
		uint16_t	index
	)

private

Set index rate as maxTpRate or maxTp2Rate if is better than current values.

Parameters

station	the Minstrel-HT wifi remote station
index	the index

Definition at line 1414 of file minstrel-ht-wifi-manager.cc.

References GetGroupId(), GetRateId(), ns3::MinstrelHtWifiRemoteStation::m_groupsTable, ns3::GroupInfo::m_maxTpRate, ns3::MinstrelWifiRemoteStation::m_maxTpRate, ns3::GroupInfo::m_maxTpRate2, ns3::MinstrelWifiRemoteStation::m_maxTpRate2, and ns3::GroupInfo::m_ratesTable.

Referenced by UpdateStats().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetNextSample()

void ns3::MinstrelHtWifiManager::SetNextSample ( MinstrelHtWifiRemoteStation * station )

private

Set the next sample from Sample Table.

Parameters

station the wifi remote station

Definition at line 1071 of file minstrel-ht-wifi-manager.cc.

References ns3::MinstrelHtWifiRemoteStation::m_groupsTable, m_nSampleCol, m_numGroups, m_numRates, ns3::MinstrelHtWifiRemoteStation::m_sampleGroup, ns3::MinstrelWifiRemoteStation::m_sampleTable, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by GetNextSample(), and RateInit().

Here is the caller graph for this function:

◆ SetupMac()

void ns3::MinstrelHtWifiManager::SetupMac ( const Ptr< WifiMac > mac )

overridevirtual

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

IFS).

Parameters

mac	the MAC of this device

Reimplemented from ns3::WifiRemoteStationManager.

Definition at line 175 of file minstrel-ht-wifi-manager.cc.

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

Here is the call graph for this function:

◆ SetupPhy()

void ns3::MinstrelHtWifiManager::SetupPhy ( const Ptr< WifiPhy > phy )

overridevirtual

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

Parameters

phy	the PHY of this device

Reimplemented from ns3::WifiRemoteStationManager.

Definition at line 166 of file minstrel-ht-wifi-manager.cc.

References m_legacyManager, NS_LOG_FUNCTION, third::phy, and ns3::WifiRemoteStationManager::SetupPhy().

Here is the call graph for this function:

◆ StatsDump()

void ns3::MinstrelHtWifiManager::StatsDump	(	MinstrelHtWifiRemoteStation *	station,
		uint8_t	groupId,
		std::ofstream &	of
	)

private

Print group statistics.

Parameters

station	the Minstrel-HT wifi remote station
groupId	the group ID
of	the output file stream

Definition at line 1735 of file minstrel-ht-wifi-manager.cc.

References CalculateThroughput(), ns3::McsGroup::chWidth, GetFirstMpduTxTime(), GetIndex(), ns3::WifiRemoteStationManager::GetMcsSupported(), ns3::Time::GetMicroSeconds(), ns3::McsGroup::gi, ns3::GROUP_HT, ns3::MinstrelHtWifiRemoteStation::m_groupsTable, ns3::MinstrelWifiRemoteStation::m_maxProbRate, ns3::MinstrelWifiRemoteStation::m_maxTpRate, ns3::MinstrelWifiRemoteStation::m_maxTpRate2, m_minstrelGroups, m_numRates, ns3::McsGroup::streams, and ns3::McsGroup::type.

Referenced by PrintTable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdatePacketCounters()

void ns3::MinstrelHtWifiManager::UpdatePacketCounters	(	MinstrelHtWifiRemoteStation *	station,
		uint16_t	nSuccessfulMpdus,
		uint16_t	nFailedMpdus
	)

private

Update the number of sample count variables.

Parameters

station	the wifi remote station
nSuccessfulMpdus	the number of successfully received MPDUs
nFailedMpdus	the number of failed MPDUs

Definition at line 841 of file minstrel-ht-wifi-manager.cc.

References ns3::MinstrelHtWifiRemoteStation::m_avgAmpduLen, ns3::MinstrelWifiRemoteStation::m_isSampling, ns3::MinstrelHtWifiRemoteStation::m_sampleCount, ns3::MinstrelWifiRemoteStation::m_samplePacketsCount, ns3::MinstrelHtWifiRemoteStation::m_sampleTries, ns3::MinstrelHtWifiRemoteStation::m_sampleWait, ns3::MinstrelWifiRemoteStation::m_totalPacketsCount, and NS_LOG_FUNCTION.

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

Here is the caller graph for this function:

◆ UpdateRate()

void ns3::MinstrelHtWifiManager::UpdateRate ( MinstrelHtWifiRemoteStation * station )

private

Update rate.

Parameters

station the Minstrel-HT wifi remote station

Retry Chain table is implemented here.

FIXME Currently, NS3 does not retransmit an entire A-MPDU when BACK is missing but retransmits each MPDU until MPDUs lifetime expires (or a BACK is received). Then, there is no way to control A-MPDU retries (no call to NeedDataRetransmission). So, it is possible that the A-MPDU keeps retrying after longRetry reaches its limit.

Try | LOOKAROUND RATE | NORMAL RATE

Note: For clarity, multiple blocks of if's and else's are used Following implementation in Linux, in MinstrelHT lowest base rate is not used. Explanation can be found here: http://marc.info/?l=linux-wireless&m=144602778611966&w=2

Get the IDs for all rates.

For normal rate, we're not currently sampling random rates.

Use best throughput rate.

< There are still a few retries.

Use second best throughput rate.

Use best probability rate.

We're currently sampling random rates.

Sample rate is used only once Use the best rate.

Use the best probability rate.

Definition at line 732 of file minstrel-ht-wifi-manager.cc.

References CheckInit(), GetGroupId(), GetRateId(), ns3::MinstrelHtWifiRemoteStation::m_groupsTable, ns3::MinstrelWifiRemoteStation::m_initialized, ns3::MinstrelWifiRemoteStation::m_isSampling, ns3::MinstrelWifiRemoteStation::m_longRetry, ns3::MinstrelWifiRemoteStation::m_maxProbRate, ns3::MinstrelWifiRemoteStation::m_maxTpRate, ns3::MinstrelWifiRemoteStation::m_maxTpRate2, ns3::MinstrelWifiRemoteStation::m_txrate, NS_FATAL_ERROR, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by DoReportAmpduTxStatus(), and DoReportDataFailed().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateRetry()

void ns3::MinstrelHtWifiManager::UpdateRetry ( MinstrelHtWifiRemoteStation * station )

private

Update the number of retries and reset accordingly.

Parameters

station the wifi remote station

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

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

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

Here is the caller graph for this function:

◆ UpdateStats()

void ns3::MinstrelHtWifiManager::UpdateStats ( MinstrelHtWifiRemoteStation * station )

private

Update the Minstrel Table.

Parameters

station the Minstrel-HT wifi remote station

Update throughput and EWMA for each rate inside each group.

If we've attempted something.

Calculate the probability of success. Assume probability scales from 0 to 100.

Bookkeeping.

EWMA probability

Bookkeeping.

Definition at line 1207 of file minstrel-ht-wifi-manager.cc.

References CalculateEwmsd(), CalculateRetransmits(), CalculateThroughput(), GetIndex(), GetLowestIndex(), ns3::WifiRemoteStationManager::GetMcsSupported(), ns3::MinstrelHtWifiRemoteStation::m_ampduLen, ns3::MinstrelHtWifiRemoteStation::m_ampduPacketCount, ns3::MinstrelHtWifiRemoteStation::m_avgAmpduLen, m_ewmaLevel, ns3::MinstrelHtWifiRemoteStation::m_groupsTable, ns3::MinstrelWifiRemoteStation::m_maxProbRate, ns3::MinstrelWifiRemoteStation::m_maxTpRate, ns3::MinstrelWifiRemoteStation::m_maxTpRate2, ns3::MinstrelWifiRemoteStation::m_nextStatsUpdate, m_numGroups, m_numRates, ns3::MinstrelHtWifiRemoteStation::m_numSamplesSlow, m_printStats, ns3::MinstrelHtWifiRemoteStation::m_sampleCount, m_updateStats, ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, PrintTable(), SetBestProbabilityRate(), and SetBestStationThRates().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_currentRate

TracedValue<uint64_t> ns3::MinstrelHtWifiManager::m_currentRate

private

Trace rate changes.

Definition at line 619 of file minstrel-ht-wifi-manager.h.

Referenced by DoGetDataTxVector(), and GetTypeId().

◆ m_ewmaLevel

uint8_t ns3::MinstrelHtWifiManager::m_ewmaLevel

private

Exponential weighted moving average level (or coefficient).

Definition at line 605 of file minstrel-ht-wifi-manager.h.

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

◆ m_frameLength

uint32_t ns3::MinstrelHtWifiManager::m_frameLength

private

Frame length used for calculate modes TxTime in bytes.

Definition at line 607 of file minstrel-ht-wifi-manager.h.

Referenced by CalculateMpduTxDuration(), CheckInit(), and GetTypeId().

◆ m_legacyManager

Ptr<MinstrelWifiManager> ns3::MinstrelHtWifiManager::m_legacyManager

private

Pointer to an instance of MinstrelWifiManager.

Used when 802.11n/ac/ax not supported.

Definition at line 615 of file minstrel-ht-wifi-manager.h.

Referenced by MinstrelHtWifiManager(), AssignStreams(), CheckInit(), DoGetDataTxVector(), DoGetRtsTxVector(), DoNeedRetransmission(), DoReportDataFailed(), DoReportDataOk(), DoReportFinalDataFailed(), SetupMac(), and SetupPhy().

◆ m_legacyUpdateStats

Time ns3::MinstrelHtWifiManager::m_legacyUpdateStats

private

How frequent do we calculate the stats for legacy MinstrelWifiManager.

Definition at line 603 of file minstrel-ht-wifi-manager.h.

Referenced by CheckInit(), and GetTypeId().

◆ m_lookAroundRate

uint8_t ns3::MinstrelHtWifiManager::m_lookAroundRate

private

The % to try other rates than our current rate.

Definition at line 604 of file minstrel-ht-wifi-manager.h.

Referenced by CheckInit(), and GetTypeId().

◆ m_minstrelGroups

MinstrelMcsGroups ns3::MinstrelHtWifiManager::m_minstrelGroups

private

Global array for groups information.

Definition at line 613 of file minstrel-ht-wifi-manager.h.

Referenced by ~MinstrelHtWifiManager(), AddFirstMpduTxTime(), AddMpduTxTime(), DoGetDataTxVector(), DoInitialize(), FindRate(), GetFirstMpduTxTime(), GetMpduTxTime(), RateInit(), and StatsDump().

◆ m_nSampleCol

uint8_t ns3::MinstrelHtWifiManager::m_nSampleCol

private

Number of sample columns.

Definition at line 606 of file minstrel-ht-wifi-manager.h.

Referenced by CheckInit(), GetTypeId(), InitSampleTable(), and SetNextSample().

◆ m_numGroups

uint8_t ns3::MinstrelHtWifiManager::m_numGroups

private

Number of groups Minstrel should consider.

Definition at line 608 of file minstrel-ht-wifi-manager.h.

Referenced by ~MinstrelHtWifiManager(), DoInitialize(), PrintTable(), RateInit(), SetNextSample(), and UpdateStats().

◆ m_numRates

uint8_t ns3::MinstrelHtWifiManager::m_numRates

private

Number of rates per group Minstrel should consider.

Definition at line 609 of file minstrel-ht-wifi-manager.h.

Referenced by CheckInit(), DoInitialize(), GetGroupId(), GetIndex(), GetRateId(), InitSampleTable(), RateInit(), SetNextSample(), StatsDump(), and UpdateStats().

◆ m_printStats

bool ns3::MinstrelHtWifiManager::m_printStats

private

If statistics table should be printed.

Definition at line 611 of file minstrel-ht-wifi-manager.h.

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

◆ m_uniformRandomVariable

Ptr<UniformRandomVariable> ns3::MinstrelHtWifiManager::m_uniformRandomVariable

private

Provides uniform random variables.

Definition at line 617 of file minstrel-ht-wifi-manager.h.

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

◆ m_updateStats

Time ns3::MinstrelHtWifiManager::m_updateStats

private

How frequent do we calculate the stats.

Definition at line 602 of file minstrel-ht-wifi-manager.h.

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

◆ m_useLatestAmendmentOnly

bool ns3::MinstrelHtWifiManager::m_useLatestAmendmentOnly

private

Flag if only the latest supported amendment by both peers should be used.

Definition at line 610 of file minstrel-ht-wifi-manager.h.

Referenced by GetTypeId(), and RateInit().

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

src/wifi/model/rate-control/minstrel-ht-wifi-manager.h
src/wifi/model/rate-control/minstrel-ht-wifi-manager.cc

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Attributes defined in parent class ns3::WifiRemoteStationManager

TraceSources

TraceSources defined in parent class ns3::WifiRemoteStationManager

Member Typedef Documentation

◆ RateChangeTracedCallback

Constructor & Destructor Documentation

◆ MinstrelHtWifiManager()

◆ ~MinstrelHtWifiManager()

Member Function Documentation

◆ AddFirstMpduTxTime()

◆ AddMpduTxTime()

◆ AssignStreams()

◆ CalculateEwmsd()

◆ CalculateMpduTxDuration()

◆ CalculateRetransmits() [1/2]

◆ CalculateRetransmits() [2/2]

◆ CalculateThroughput()

◆ CalculateTimeUnicastPacket()

◆ CheckInit()

◆ CountRetries()

◆ DoCreateStation()

◆ DoGetDataTxVector()

◆ DoGetRtsTxVector()

◆ DoInitialize()

◆ DoNeedRetransmission()

◆ DoReportAmpduTxStatus()

◆ DoReportDataFailed()

◆ DoReportDataOk()

◆ DoReportFinalDataFailed()

◆ DoReportFinalRtsFailed()

◆ DoReportRtsFailed()

◆ DoReportRtsOk()

◆ DoReportRxOk()

◆ FindRate()

◆ GetFirstMpduTxTime()

◆ GetGroupId()

◆ GetHeDeviceMcsList()

◆ GetHeGroupId()

◆ GetHtDeviceMcsList()

◆ GetHtGroupId()

◆ GetIndex()

◆ GetLowestIndex() [1/2]

◆ GetLowestIndex() [2/2]

◆ GetMpduTxTime()

◆ GetNextSample()

◆ GetRateId()

◆ GetTypeId()

◆ GetVhtDeviceMcsList()

◆ GetVhtGroupId()

◆ InitSampleTable()

◆ IsValidMcs()

◆ PrintSampleTable()

◆ PrintTable()

◆ RateInit()

◆ SetBestProbabilityRate()

◆ SetBestStationThRates()

◆ SetNextSample()

◆ SetupMac()

◆ SetupPhy()

◆ StatsDump()

◆ UpdatePacketCounters()

◆ UpdateRate()

Try | LOOKAROUND RATE | NORMAL RATE

◆ UpdateRetry()

◆ UpdateStats()

Member Data Documentation

◆ m_currentRate

◆ m_ewmaLevel

◆ m_frameLength

◆ m_legacyManager

◆ m_legacyUpdateStats