A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::MinstrelWifiManager Class Reference

Implementation of Minstrel Rate Control AlgorithmPorting Minstrel from Madwifi and Linux Kernel http://linuxwireless.org/en/developers/Documentation/mac80211/RateControl/minstrel. 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...
 
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...
 
- Public Member Functions inherited from ns3::WifiRemoteStationManager
 WifiRemoteStationManager ()
 
virtual ~WifiRemoteStationManager ()
 
void AddBasicMcs (uint8_t 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 AddSupportedMcs (Mac48Address address, uint8_t 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...
 
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)
 
uint8_t 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, uint32_t fullPacketSize)
 
uint8_t 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...
 
WifiMode GetNonUnicastMode (void) const
 Return a mode for non-unicast packets. More...
 
uint32_t GetNumberOfTransmitAntennas (void)
 
uint32_t GetRtsCtsThreshold (void) const
 Return the RTS threshold. More...
 
WifiTxVector GetRtsTxVector (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet)
 
bool HasHtSupported (void) const
 Return whether the device has HT 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)
 
bool NeedRtsRetransmission (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet)
 
void PrepareForQueue (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet, uint32_t fullPacketSize)
 
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 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 SetHtSupported (bool enable)
 Enable or disable HT capability support. 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 SetRtsCtsThreshold (uint32_t threshold)
 Sets the RTS threshold. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 Run the DoDispose methods of this object and all the objects aggregated to it. More...
 
AggregateIterator GetAggregateIterator (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
template<typename T >
Ptr< T > GetObject (void) const
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 
void Initialize (void)
 This method calls the virtual DoInitialize method on all the objects aggregated to this object. 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...
 
SimpleRefCountoperator= (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
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

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...
 
void CheckInit (MinstrelWifiRemoteStation *station)
 check for initializations More...
 
virtual WifiRemoteStationDoCreateStation (void) const
 
virtual WifiTxVector DoGetDataTxVector (WifiRemoteStation *station, uint32_t size)
 
virtual WifiTxVector DoGetRtsTxVector (WifiRemoteStation *station)
 
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...
 
uint32_t FindRate (MinstrelWifiRemoteStation *station)
 find a rate to use from Minstrel Table More...
 
Time GetCalcTxTime (WifiMode mode) const
 for estimating the TxTime of a packet with a given mode More...
 
uint32_t GetNextSample (MinstrelWifiRemoteStation *station)
 getting the next sample from Sample Table More...
 
void InitSampleTable (MinstrelWifiRemoteStation *station)
 initialize Sample Table More...
 
virtual bool IsLowLatency (void) const
 
void PrintSampleTable (MinstrelWifiRemoteStation *station)
 printing Sample Table More...
 
void PrintTable (MinstrelWifiRemoteStation *station)
 printing Minstrel Table More...
 
void RateInit (MinstrelWifiRemoteStation *station)
 initialize Minstrel Table More...
 
void UpdateRetry (MinstrelWifiRemoteStation *station)
 update the number of retries and reset accordingly More...
 
void UpdateStats (MinstrelWifiRemoteStation *station)
 updating the Minstrel Table every 1/10 seconds More...
 

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...
 
MinstrelRate m_minstrelTable
 minstrel table More...
 
uint32_t m_nsupported
 modes supported More...
 
uint32_t m_pktLen
 packet length used for calculate mode TxTime More...
 
uint32_t m_sampleCol
 number of sample columns More...
 
SampleRate m_sampleTable
 sample table More...
 
Ptr< UniformRandomVariablem_uniformRandomVariable
 Provides uniform random variables. More...
 
Time m_updateStats
 how frequent do we calculate the stats(1/10 seconds) More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::WifiRemoteStationManager
virtual void DoDispose (void)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
bool GetGreenfield (const WifiRemoteStation *station) const
 Return whether the station supports Greenfield or not. More...
 
uint32_t GetLongRetryCount (const WifiRemoteStation *station) const
 Return the long retry limit of the given station. More...
 
uint8_t GetMcsSupported (const WifiRemoteStation *station, uint32_t i) const
 Return the MCS index supported by the specified station at the specified index. More...
 
uint32_t GetNMcsSupported (const WifiRemoteStation *station) const
 Return the number of MCS supported by the given station. More...
 
uint32_t GetNSupported (const WifiRemoteStation *station) const
 Return the number of modes supported by the given station. More...
 
uint32_t GetNumberOfReceiveAntennas (const WifiRemoteStation *station) const
 Return the number of receive antenna the station has. More...
 
uint32_t GetNumberOfTransmitAntennas (const WifiRemoteStation *station) const
 Return the number of transmit antenna the station has. 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...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoInitialize (void)
 This method is called only once by Object::Initialize. More...
 
virtual void NotifyNewAggregate (void)
 This method is invoked whenever two sets of objects are aggregated together. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

Detailed Description

Implementation of Minstrel Rate Control Algorithm

Porting Minstrel from Madwifi and Linux Kernel http://linuxwireless.org/en/developers/Documentation/mac80211/RateControl/minstrel.

Author
Duy Nguyen

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::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 10
    • Flags: construct write read
  • PacketLength: The packet length used for calculating mode TxTime
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 1200
    • 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.
  • MaxSsrc: The maximum number of retransmission attempts for an RTS. This value will not have any effect on some rate control algorithms.
  • MaxSlrc: The maximum number of retransmission attempts for a DATA packet. This value will not have any effect on some rate control algorithms.
  • RtsCtsThreshold: If the size of the data packet + LLC header + MAC header + FCS trailer is bigger than this value, we use an RTS/CTS handshake before sending the data, as per IEEE Std. 802.11-2007, Section 9.2.6. This value will not have any effect on some rate control algorithms.
  • FragmentationThreshold: If the size of the data packet + LLC header + MAC header + FCS trailer is biggerthan this value, we fragment it such that the size of the fragments are equal or smaller than this value, as per IEEE Std. 802.11-2007, Section 9.4. This value will not have any effect on some rate control algorithms.
  • 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 notimplement TX power control.

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
  • MacTxDataFailed: The transmission of a data packet by the MAC layer has failed
  • MacTxFinalRtsFailed: The transmission of a RTS has exceeded the maximum number of attempts
  • MacTxFinalDataFailed: The transmission of a data packet has exceeded the maximum number of attempts

Definition at line 87 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 165 of file minstrel-wifi-manager.h.

Constructor & Destructor Documentation

ns3::MinstrelWifiManager::MinstrelWifiManager ( )

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

References m_nsupported, and m_uniformRandomVariable.

ns3::MinstrelWifiManager::~MinstrelWifiManager ( )
virtual

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

Member Function Documentation

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

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

Parameters
modeWi-Fi mode
ttransmission time

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

References m_calcTxTime.

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
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

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

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

+ Here is the call graph for this function:

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

check for initializations

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

References ns3::WifiRemoteStationManager::GetNSupported(), InitSampleTable(), ns3::MinstrelWifiRemoteStation::m_initialized, m_minstrelTable, m_nsupported, m_sampleCol, m_sampleTable, and RateInit().

Referenced by DoGetDataTxVector(), DoReportDataFailed(), and DoReportDataOk().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

WifiTxVector ns3::MinstrelWifiManager::DoGetDataTxVector ( WifiRemoteStation station,
uint32_t  size 
)
privatevirtual
Parameters
stationthe station that we need to communicate
sizesize of the packet or fragment we want to send
Returns
the transmission mode 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.

start the rate at half way

Implements ns3::WifiRemoteStationManager.

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

References CheckInit(), ns3::WifiRemoteStationManager::GetDefaultTxPowerLevel(), ns3::WifiRemoteStationManager::GetLongRetryCount(), ns3::WifiRemoteStationManager::GetNumberOfReceiveAntennas(), ns3::WifiRemoteStationManager::GetNumberOfTransmitAntennas(), ns3::WifiRemoteStationManager::GetShortGuardInterval(), ns3::WifiRemoteStationManager::GetStbc(), ns3::WifiRemoteStationManager::GetSupported(), ns3::MinstrelWifiRemoteStation::m_initialized, m_nsupported, ns3::MinstrelWifiRemoteStation::m_txrate, ns3::Min(), and UpdateStats().

+ Here is the call graph for this function:

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

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

Implements ns3::WifiRemoteStationManager.

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

References ns3::WifiRemoteStationManager::GetDefaultTxPowerLevel(), ns3::WifiRemoteStationManager::GetNumberOfReceiveAntennas(), ns3::WifiRemoteStationManager::GetNumberOfTransmitAntennas(), ns3::WifiRemoteStationManager::GetShortGuardInterval(), ns3::WifiRemoteStationManager::GetShortRetryCount(), ns3::WifiRemoteStationManager::GetStbc(), ns3::WifiRemoteStationManager::GetSupported(), ns3::MinstrelWifiRemoteStation::m_txrate, ns3::Min(), and NS_LOG_DEBUG.

+ 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
stationthe station that we failed to send DATA

Retry Chain table is implemented here

Try | LOOKAROUND RATE | NORMAL RATE

| random < best | random > best |

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

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

for normal rate, we're not currently sampling random rates

use best throughput rate

< there's still a few retries left

use second best throughput rate

use best probability rate

use lowest base rate

for look-around rate, we're currently sampling random rates

current sampling rate is slower than the current best rate

use best throughput rate

< there are a few retries left

use random rate

use max probability rate

use lowest base rate

current sampling rate is better than current best rate

use random rate

< keep using it

use the best rate

use the best probability rate

use the lowest base rate

Implements ns3::WifiRemoteStationManager.

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

References CheckInit(), ns3::MinstrelWifiRemoteStation::m_initialized, ns3::MinstrelWifiRemoteStation::m_isSampling, ns3::MinstrelWifiRemoteStation::m_longRetry, ns3::MinstrelWifiRemoteStation::m_maxProbRate, ns3::MinstrelWifiRemoteStation::m_maxTpRate, ns3::MinstrelWifiRemoteStation::m_maxTpRate2, m_minstrelTable, ns3::MinstrelWifiRemoteStation::m_sampleRate, ns3::MinstrelWifiRemoteStation::m_sampleRateSlower, ns3::MinstrelWifiRemoteStation::m_txrate, and NS_LOG_DEBUG.

+ 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
stationthe station that we successfully sent RTS
ackSnrthe SNR of the ACK we received
ackModethe WifiMode the receiver used to send the ACK
dataSnrthe SNR of the DATA we sent

Implements ns3::WifiRemoteStationManager.

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

References CheckInit(), FindRate(), ns3::MinstrelWifiRemoteStation::m_initialized, ns3::MinstrelWifiRemoteStation::m_isSampling, m_minstrelTable, m_nsupported, ns3::MinstrelWifiRemoteStation::m_packetCount, ns3::MinstrelWifiRemoteStation::m_retry, ns3::MinstrelWifiRemoteStation::m_sampleRateSlower, ns3::MinstrelWifiRemoteStation::m_txrate, and UpdateRetry().

+ 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
stationthe station that we failed to send DATA

Implements ns3::WifiRemoteStationManager.

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

References FindRate(), ns3::MinstrelWifiRemoteStation::m_err, ns3::MinstrelWifiRemoteStation::m_isSampling, m_minstrelTable, m_nsupported, ns3::MinstrelWifiRemoteStation::m_retry, ns3::MinstrelWifiRemoteStation::m_sampleRateSlower, ns3::MinstrelWifiRemoteStation::m_txrate, NS_LOG_DEBUG, and UpdateRetry().

+ 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
stationthe station that we failed to send RTS

Implements ns3::WifiRemoteStationManager.

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

References ns3::MinstrelWifiRemoteStation::m_err, 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
stationthe station that we failed to send RTS

Implements ns3::WifiRemoteStationManager.

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

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

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

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

This allows different types of WifiRemoteStationManager to respond differently,

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

Implements ns3::WifiRemoteStationManager.

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

References NS_LOG_DEBUG.

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

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

This allows different types of WifiRemoteStationManager to respond differently,

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

Implements ns3::WifiRemoteStationManager.

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

References NS_LOG_DEBUG.

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

find a rate to use from Minstrel Table

for determining when to try a sample rate

if we are below the target of look around rate percentage, look around note: do it randomly by flipping a coin instead sampling all at once until it reaches the look around rate

now go through the table and find an index rate

This if condition is used to make sure that we don't need to use the sample rate it is the same as our current rate

start sample count

set flag that we are currently sampling

bookeeping for resetting stuff

error check

set the rate that we're currently sampling

is this rate slower than the current best rate

using the best rate instead

continue using the best rate

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

References ns3::UniformRandomVariable::GetInteger(), GetNextSample(), ns3::MinstrelWifiRemoteStation::m_isSampling, m_lookAroundRate, ns3::MinstrelWifiRemoteStation::m_maxTpRate, ns3::MinstrelWifiRemoteStation::m_maxTpRate2, m_minstrelTable, m_nsupported, ns3::MinstrelWifiRemoteStation::m_packetCount, ns3::MinstrelWifiRemoteStation::m_sampleCount, ns3::MinstrelWifiRemoteStation::m_sampleRate, ns3::MinstrelWifiRemoteStation::m_sampleRateSlower, ns3::MinstrelWifiRemoteStation::m_txrate, m_uniformRandomVariable, and NS_LOG_DEBUG.

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

for estimating the TxTime of a packet with a given mode

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

References m_calcTxTime, and NS_ASSERT.

Referenced by RateInit().

+ Here is the caller graph for this function:

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

getting the next sample from Sample Table

bookeeping for m_index and m_col variables

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

References ns3::MinstrelWifiRemoteStation::m_col, ns3::MinstrelWifiRemoteStation::m_index, m_nsupported, m_sampleCol, and m_sampleTable.

Referenced by FindRate().

+ Here is the caller graph for this function:

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

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

References m_ewmaLevel, m_lookAroundRate, m_pktLen, m_sampleCol, m_updateStats, ns3::MakeTimeChecker(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

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

initialize Sample Table

for off-seting to make rates fall between 0 and numrates

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

this loop is used for filling in other uninitilized places

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

References ns3::UniformRandomVariable::GetInteger(), ns3::MinstrelWifiRemoteStation::m_col, ns3::MinstrelWifiRemoteStation::m_index, m_nsupported, m_sampleCol, 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 469 of file minstrel-wifi-manager.cc.

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

printing Sample Table

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

References m_nsupported, m_sampleCol, m_sampleTable, and NS_LOG_DEBUG.

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

printing Minstrel Table

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

References m_minstrelTable, m_nsupported, and NS_LOG_DEBUG.

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

initialize Minstrel Table

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

References GetCalcTxTime(), ns3::WifiRemoteStationManager::GetSupported(), m_minstrelTable, m_nsupported, and NS_LOG_DEBUG.

Referenced by CheckInit(), and UpdateStats().

+ Here is the call graph for this function:

+ Here is the caller 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
phythe PHY of this device

Reimplemented from ns3::WifiRemoteStationManager.

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

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

+ Here is the call graph for this function:

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

update the number of retries and reset accordingly

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

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

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

+ Here is the caller graph for this function:

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

updating the Minstrel Table every 1/10 seconds

calculate the perfect tx time for this rate

just for initialization

if we've attempted something

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

bookeeping

ewma probability (cast for gcc 3.4 compatibility)

calculating throughput

bookeeping

Sample less often below 10% and above 95% of success

retry count denotes the number of retries permitted for each rate

retry_count/2

if it's 0 allow one retry limit

go find max throughput, second maximum throughput, high probability succ

find the second highest max

reset it

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

References ns3::Time::GetMicroSeconds(), ns3::MinstrelWifiRemoteStation::m_currentRate, m_ewmaLevel, ns3::MinstrelWifiRemoteStation::m_initialized, ns3::MinstrelWifiRemoteStation::m_maxProbRate, ns3::MinstrelWifiRemoteStation::m_maxTpRate, ns3::MinstrelWifiRemoteStation::m_maxTpRate2, m_minstrelTable, ns3::MinstrelWifiRemoteStation::m_nextStatsUpdate, m_nsupported, ns3::MinstrelWifiRemoteStation::m_txrate, m_updateStats, ns3::Simulator::Now(), NS_LOG_DEBUG, RateInit(), and throughput.

Referenced by DoGetDataTxVector().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

TxTime ns3::MinstrelWifiManager::m_calcTxTime
private

to hold all the calculated TxTime for all modes

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

Referenced by AddCalcTxTime(), and GetCalcTxTime().

double ns3::MinstrelWifiManager::m_ewmaLevel
private

exponential weighted moving average

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

Referenced by GetTypeId(), and UpdateStats().

double ns3::MinstrelWifiManager::m_lookAroundRate
private

the % to try other rates than our current rate

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

Referenced by FindRate(), and GetTypeId().

MinstrelRate ns3::MinstrelWifiManager::m_minstrelTable
private
uint32_t ns3::MinstrelWifiManager::m_nsupported
private
uint32_t ns3::MinstrelWifiManager::m_pktLen
private

packet length used for calculate mode TxTime

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

Referenced by GetTypeId(), and SetupPhy().

uint32_t ns3::MinstrelWifiManager::m_sampleCol
private

number of sample columns

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

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

SampleRate ns3::MinstrelWifiManager::m_sampleTable
private

sample table

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

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

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

Provides uniform random variables.

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

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

Time ns3::MinstrelWifiManager::m_updateStats
private

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

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

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


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