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:

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

uint32_t	FindRate (MinstrelWifiRemoteStation *station)

WifiTxVector	GetDataTxVector (MinstrelWifiRemoteStation *station)

WifiTxVector	GetRtsTxVector (MinstrelWifiRemoteStation *station)

void	InitSampleTable (MinstrelWifiRemoteStation *station)

virtual void	SetHtSupported (bool enable)
	Enable or disable HT capability support. More...

virtual void	SetupMac (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...

virtual void	SetupPhy (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...

virtual void	SetVhtSupported (bool enable)
	Enable or disable VHT capability support. More...

void	UpdatePacketCounters (MinstrelWifiRemoteStation *station)

void	UpdateRate (MinstrelWifiRemoteStation *station)
	Retry Chain table is implemented here. More...

void	UpdateRetry (MinstrelWifiRemoteStation *station)

void	UpdateStats (MinstrelWifiRemoteStation *station)

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	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 (uint32_t i) const
	Return the MCS at the given list index. More...

WifiMode	GetBasicMode (uint32_t i) const
	Return a basic mode from the set of basic modes. More...

WifiTxVector	GetBlockAckTxVector (Mac48Address address, WifiMode dataMode)

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

WifiRemoteStationInfo	GetInfo (Mac48Address address)

uint32_t	GetMaxSlrc (void) const
	Return the maximum STA long retry count (SLRC). More...

uint32_t	GetMaxSsrc (void) const
	Return the maximum STA short retry count (SSRC). More...

uint32_t	GetNBasicMcs (void) const
	Return the number of basic MCS index. More...

uint32_t	GetNBasicModes (void) const
	Return the number of basic modes we support. More...

uint32_t	GetNNonErpBasicModes (void) const
	Return the number of non-ERP basic modes we support. More...

WifiMode	GetNonErpBasicMode (uint32_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...

uint32_t	GetNumberOfTransmitAntennas (void)

ProtectionMode	GetProtectionMode (void) const
	Return the protection mode. More...

uint32_t	GetRtsCtsThreshold (void) const
	Return the RTS threshold. More...

WifiTxVector	GetRtsTxVector (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet)

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	GetUseNonErpProtection (void) const
	Return whether the device supports protection of non-ERP stations. More...

bool	HasHtSupported (void) const
	Return whether the device has HT 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	NeedDataRetransmission (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet)

bool	NeedFragmentation (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet)

bool	NeedRts (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet, WifiTxVector txVector)

bool	NeedRtsRetransmission (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet)

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	ReportAmpduTxStatus (Mac48Address address, uint8_t tid, uint32_t nSuccessfulMpdus, uint32_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)
	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)
	Should be invoked whenever we receive the Ack associated to a data packet we just sent. More...

void	ReportFinalDataFailed (Mac48Address address, const WifiMacHeader *header)
	Should be invoked after calling ReportDataFailed if NeedDataRetransmission returns false. More...

void	ReportFinalRtsFailed (Mac48Address address, const WifiMacHeader *header)
	Should be invoked after calling ReportRtsFailed if NeedRtsRetransmission 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	Reset (Mac48Address address)
	Invoked in an AP upon disassociation of a specific STA. 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	SetProtectionMode (ProtectionMode mode)
	Sets the protection mode. 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	SetUseNonErpProtection (bool enable)
	Enable or disable protection for non-ERP 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
	Implement the GetInstanceTypeId method defined in ObjectBase. 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 ()
	Constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

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

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. 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)

Static Public Member Functions inherited from ns3::WifiRemoteStationManager
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...

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

Private Types
typedef std::vector< std::pair< Time, WifiMode > >	TxTime
	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...

virtual WifiRemoteStation *	DoCreateStation (void) const

virtual WifiTxVector	DoGetDataTxVector (WifiRemoteStation *station)

virtual WifiTxVector	DoGetRtsTxVector (WifiRemoteStation *station)

virtual bool	DoNeedDataRetransmission (WifiRemoteStation *st, Ptr< const Packet > packet, bool normally)

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

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

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

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

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

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

virtual 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

uint32_t	GetNextSample (MinstrelWifiRemoteStation *station)

virtual bool	IsLowLatency (void) const

void	PrintSampleTable (MinstrelWifiRemoteStation *station)

void	PrintTable (MinstrelWifiRemoteStation *station)

void	RateInit (MinstrelWifiRemoteStation *station)

Private Attributes
TxTime	m_calcTxTime
	to hold all the calculated TxTime for all modes More...

double	m_ewmaLevel
	exponential weighted moving average More...

double	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_printStats
	If statistics table should be printed. More...

uint32_t	m_sampleCol
	number of sample columns More...

Ptr< UniformRandomVariable >	m_uniformRandomVariable

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) (uint8_t power, Mac48Address remoteAddress)
	TracedCallback signature for power change events. More...

enum	ProtectionMode { RTS_CTS, CTS_TO_SELF }

typedef void(*	RateChangeTracedCallback) (uint32_t rate, Mac48Address remoteAddress)
	TracedCallback signature for rate change events. More...

Protected Member Functions inherited from ns3::WifiRemoteStationManager
virtual void	DoDispose (void)
	Destructor implementation. More...

bool	GetAggregation (const WifiRemoteStation *station) const
	Return whether the given station supports A-MPDU. More...

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

bool	GetHtSupported (const WifiRemoteStation *station) const
	Return whether the given station is HT capable. More...

uint32_t	GetLongRetryCount (const WifiRemoteStation *station) const
	Return the long retry limit of the given station. More...

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

WifiMode	GetMcsSupported (const WifiRemoteStation *station, uint32_t i) const
	Return the WifiMode supported by the specified station at the specified index. More...

uint32_t	GetNess (const WifiRemoteStation *station) const

uint32_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, uint32_t i) const
	Return whether non-ERP mode associated with the specified station at the specified index. More...

uint32_t	GetNSupported (const WifiRemoteStation *station) const
	Return the number of modes supported by the given station. More...

uint8_t	GetNumberOfSupportedRxAntennas (const WifiRemoteStation *station) const
	Return the number of receive antennas the station has. More...

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

bool	GetShortGuardInterval (const WifiRemoteStation *station) const
	Return whether the given station supports short guard interval. More...

uint32_t	GetShortRetryCount (const WifiRemoteStation *station) const
	Return the short retry limit of the given station. More...

bool	GetStbc (const WifiRemoteStation *station) const
	Return whether the given station supports space-time block coding (STBC). More...

WifiMode	GetSupported (const WifiRemoteStation *station, uint32_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...

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 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 configurations; for HT/VHT (i.e. 802.11n/ac), users should use MinstrelHtWifiManager instead. Minstrel will error exit if the user tries to configure it with a Wi-Fi MAC that has VhtSupported or HtSupported 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 deffered to the second MRR chain stage, a new parameter (numSamplesDeferred) is increased. This paramters 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:

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

Attributes

UpdateStatistics: The interval between updating statistics table
- Set with class: ns3::TimeValue
- Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: +100000000.0ns
- Flags: construct write read
LookAroundRate: the percentage to try other rates
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 10
- Flags: construct write read
EWMA: EWMA level
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 75
- Flags: construct write read
SampleColumn: The number of columns used for sampling
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 10
- Flags: construct write read
PacketLength: The packet length used for calculating mode TxTime
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 1200
- Flags: construct write read
PrintStats: Print statistics table
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: construct write read

Attributes defined in parent class ns3::WifiRemoteStationManager

IsLowLatency: If true, we attempt to modelize a so-called low-latency device: a device where decisions about tx parameters can be made on a per-packet basis and feedback about the transmission of each packet is obtained before sending the next. Otherwise, we modelize a high-latency device, that is a device where we cannot update our decision about tx parameters after every packet transmission.
- Set with class: BooleanValue
- Underlying type: bool
- Flags: read
MaxSsrc: The maximum number of retransmission attempts for an RTS. 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 read
MaxSlrc: The maximum number of retransmission attempts for a DATA packet. 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 read
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 read
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: 2346
- 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
ProtectionMode: 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

No TraceSources are defined for this type.

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 328 bytes (on a 64-bit architecture).

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

Member Typedef Documentation

typedef std::vector<std::pair<Time,WifiMode> > ns3::MinstrelWifiManager::TxTime

private

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

(Essentially a list for WifiMode and its corresponding transmission time to transmit a reference packet.

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

Constructor & Destructor Documentation

ns3::MinstrelWifiManager::MinstrelWifiManager ( )

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

References m_uniformRandomVariable, and NS_LOG_FUNCTION.

ns3::MinstrelWifiManager::~MinstrelWifiManager ( )

virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

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

private

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

Parameters

mode	Wi-Fi mode
t	transmission time

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

References m_calcTxTime, and NS_LOG_FUNCTION.

Referenced by SetupPhy().

Here is the caller graph for this function:

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

stream first stream index to use

Returns: the number of stream indices assigned by this model

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

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

Here is the call graph for this function:

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

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

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

Referenced by RateInit().

Here is the call graph for this function:

Here is the caller graph for this function:

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

check for initializations

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

References ns3::WifiRemoteStationManager::GetNSupported(), InitSampleTable(), ns3::WifiRemoteStationState::m_address, ns3::MinstrelWifiRemoteStation::m_initialized, ns3::MinstrelWifiRemoteStation::m_minstrelTable, ns3::MinstrelWifiRemoteStation::m_nModes, m_sampleCol, ns3::MinstrelWifiRemoteStation::m_sampleTable, ns3::WifiRemoteStation::m_state, ns3::MinstrelWifiRemoteStation::m_statsFile, NS_LOG_FUNCTION, and RateInit().

Referenced by DoNeedDataRetransmission(), DoReportDataFailed(), DoReportDataOk(), DoReportFinalDataFailed(), and GetDataTxVector().

Here is the call graph for this function:

Here is the caller graph for this function:

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

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

References ns3::MinstrelWifiRemoteStation::m_isSampling, ns3::MinstrelWifiRemoteStation::m_maxProbRate, ns3::MinstrelWifiRemoteStation::m_maxTpRate, ns3::MinstrelWifiRemoteStation::m_maxTpRate2, ns3::MinstrelWifiRemoteStation::m_minstrelTable, and ns3::MinstrelWifiRemoteStation::m_sampleRate.

Referenced by DoNeedDataRetransmission().

Here is the caller graph for this function:

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

privatevirtual

Returns: a new station data structure

Implements ns3::WifiRemoteStationManager.

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

Here is the call graph for this function:

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

privatevirtual

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 826 of file minstrel-wifi-manager.cc.

References GetDataTxVector(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

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

privatevirtual

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 834 of file minstrel-wifi-manager.cc.

References GetRtsTxVector(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

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

privatevirtual

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 a unicast packet transmission has been attempted and has failed.

Reimplemented from ns3::WifiRemoteStationManager.

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

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

Here is the call graph for this function:

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

station the station that we failed to send DATA

Implements ns3::WifiRemoteStationManager.

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

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

Here is the call graph for this function:

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

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

Implements ns3::WifiRemoteStationManager.

Definition at line 732 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().

Here is the call graph for this function:

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

station the station that we failed to send DATA

Implements ns3::WifiRemoteStationManager.

Definition at line 763 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().

Here is the call graph for this function:

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

station the station that we failed to send RTS

Implements ns3::WifiRemoteStationManager.

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

References NS_LOG_FUNCTION, and UpdateRetry().

Here is the call graph for this function:

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

station the station that we failed to send RTS

Implements ns3::WifiRemoteStationManager.

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

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

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

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 703 of file minstrel-wifi-manager.cc.

References NS_LOG_DEBUG, and NS_LOG_FUNCTION.

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

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 686 of file minstrel-wifi-manager.cc.

References NS_LOG_FUNCTION.

uint32_t ns3::MinstrelWifiManager::FindRate ( MinstrelWifiRemoteStation * station )

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

Referenced by DoReportDataOk(), and DoReportFinalDataFailed().

Here is the call graph for this function:

Here is the caller graph for this function:

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

private

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

References m_calcTxTime, NS_ASSERT, NS_LOG_FUNCTION, and ns3::Seconds().

Referenced by RateInit().

Here is the call graph for this function:

Here is the caller graph for this function:

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

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

References CheckInit(), ns3::WifiRemoteStationManager::GetAggregation(), ns3::WifiRemoteStationManager::GetChannelWidth(), ns3::WifiRemoteStationManager::GetDefaultTxPowerLevel(), ns3::WifiRemoteStationManager::GetLongRetryCount(), ns3::WifiRemoteStationManager::GetSupported(), ns3::MinstrelWifiRemoteStation::m_initialized, ns3::MinstrelWifiRemoteStation::m_nModes, ns3::MinstrelWifiRemoteStation::m_txrate, and NS_LOG_FUNCTION.

Referenced by DoGetDataTxVector().

Here is the call graph for this function:

Here is the caller graph for this function:

uint32_t ns3::MinstrelWifiManager::GetNextSample ( MinstrelWifiRemoteStation * station )

private

Definition at line 870 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, and NS_LOG_FUNCTION.

Referenced by FindRate().

Here is the caller graph for this function:

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

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

References ns3::WifiRemoteStationManager::GetAggregation(), ns3::WifiRemoteStationManager::GetChannelWidth(), ns3::WifiRemoteStationManager::GetDefaultTxPowerLevel(), ns3::WifiRemoteStationManager::GetNonErpSupported(), ns3::WifiRemoteStationManager::GetShortRetryCount(), ns3::WifiRemoteStationManager::GetSupported(), ns3::WifiRemoteStationManager::GetUseNonErpProtection(), ns3::MinstrelWifiRemoteStation::m_txrate, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by DoGetRtsTxVector().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeId ns3::MinstrelWifiManager::GetTypeId ( void )

static

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

References m_ewmaLevel, m_lookAroundRate, m_pktLen, m_printStats, m_sampleCol, m_updateStats, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeDoubleAccessor(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeUintegerAccessor(), ns3::Seconds(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

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

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

Definition at line 961 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, and NS_LOG_DEBUG.

Referenced by CheckInit().

Here is the call graph for this function:

Here is the caller graph for this function:

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 863 of file minstrel-wifi-manager.cc.

References NS_LOG_FUNCTION.

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

private

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

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

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

private

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

Referenced by UpdateStats().

Here is the call graph for this function:

Here is the caller graph for this function:

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

private

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

References CalculateTimeUnicastPacket(), GetCalcTxTime(), ns3::WifiRemoteStationManager::GetSupported(), ns3::MinstrelWifiRemoteStation::m_minstrelTable, ns3::MinstrelWifiRemoteStation::m_nModes, ns3::MilliSeconds(), NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Seconds(), and UpdateStats().

Referenced by CheckInit().

Here is the call graph for this function:

Here is the caller graph for this function:

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

virtual

Enable or disable HT capability support.

Parameters

enable enable or disable HT capability support

Reimplemented from ns3::WifiRemoteStationManager.

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

References NS_FATAL_ERROR.

void ns3::MinstrelWifiManager::SetupMac ( 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

phy	the PHY of this device

Reimplemented from ns3::WifiRemoteStationManager.

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

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

Here is the call graph for this function:

void ns3::MinstrelWifiManager::SetupPhy ( 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

phy	the PHY of this device

Reimplemented from ns3::WifiRemoteStationManager.

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

References AddCalcTxTime(), ns3::WifiPhy::CalculateTxDuration(), ns3::WifiPhy::GetFrequency(), ns3::WifiPhy::GetMode(), ns3::WifiPhy::GetNModes(), m_pktLen, NS_LOG_FUNCTION, ns3::WifiTxVector::SetMode(), ns3::WifiRemoteStationManager::SetupPhy(), and ns3::WIFI_PREAMBLE_LONG.

Here is the call graph for this function:

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

virtual

Enable or disable VHT capability support.

Parameters

enable enable or disable VHT capability support

Reimplemented from ns3::WifiRemoteStationManager.

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

References NS_FATAL_ERROR.

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

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

References ns3::MinstrelWifiRemoteStation::m_isSampling, ns3::MinstrelWifiRemoteStation::m_longRetry, ns3::MinstrelWifiRemoteStation::m_maxTpRate, ns3::MinstrelWifiRemoteStation::m_minstrelTable, ns3::MinstrelWifiRemoteStation::m_numSamplesDeferred, ns3::MinstrelWifiRemoteStation::m_sampleDeferred, ns3::MinstrelWifiRemoteStation::m_samplePacketsCount, ns3::MinstrelWifiRemoteStation::m_totalPacketsCount, and NS_LOG_FUNCTION.

Referenced by DoReportDataOk(), and DoReportFinalDataFailed().

Here is the caller graph for this function:

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

Retry Chain table is implemented here.

Try | LOOKAROUND RATE | NORMAL RATE

| random < best | random > best |

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 220 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().

Here is the caller graph for this function:

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

Definition at line 817 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().

Here is the caller graph for this function:

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

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 512 of file minstrel-wifi-manager.cc.