Ideal rate control algorithmThis class implements an 'ideal' rate control algorithm similar to RBAR in spirit (see A rate-adaptive MAC protocol for multihop wireless networks by G. More...

#include <ideal-wifi-manager.h>

Inheritance diagram for ns3::IdealWifiManager:

Collaboration diagram for ns3::IdealWifiManager:

Public Member Functions
	IdealWifiManager ()

virtual	~IdealWifiManager ()

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

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

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 < double, WifiMode > >	Thresholds
	A vector of <snr, mode> pair that holds the minimum SNR for different mode. More...

Private Member Functions
void	AddModeSnrThreshold (WifiMode mode, double snr)
	Adds a pair of WifiMode and the minimum SNR for that given mode to the list. More...

virtual WifiRemoteStation *	DoCreateStation (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...

double	GetSnrThreshold (WifiMode mode) const
	Return the minimum SNR needed to successfully transmit data with this mode at the specified BER. More...

virtual bool	IsLowLatency (void) const

Private Attributes
double	m_ber
	The maximum Bit Error Rate acceptable at any transmission mode. More...

Thresholds	m_thresholds
	List of WifiMode and the minimum SNR pair. 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

Ideal rate control algorithm

This class implements an 'ideal' rate control algorithm similar to RBAR in spirit (see A rate-adaptive MAC protocol for multihop wireless networks by G.

Holland, N. Vaidya, and P. Bahl.): every station keeps track of the snr of every packet received and sends back this snr to the original transmitter by an out-of-band mechanism. Each transmitter keeps track of the last snr sent back by a receiver and uses it to pick a transmission mode based on a set of snr thresholds built from a target ber and transmission mode-specific snr/ber curves.

Config Paths

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

/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/RemoteStationManager/$ns3::IdealWifiManager

Attributes

BerThreshold: The maximum Bit Error Rate acceptable at any transmission mode
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 1e-05
- 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 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.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 2346
- Flags: construct write read
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.
- 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 notimplement TX power control.
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 0
- 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
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 45 of file ideal-wifi-manager.h.

Member Typedef Documentation

typedef std::vector<std::pair<double,WifiMode> > ns3::IdealWifiManager::Thresholds

private

A vector of <snr, mode> pair that holds the minimum SNR for different mode.

Definition at line 91 of file ideal-wifi-manager.h.

Constructor & Destructor Documentation

ns3::IdealWifiManager::IdealWifiManager ( )

Definition at line 59 of file ideal-wifi-manager.cc.

ns3::IdealWifiManager::~IdealWifiManager ( )

virtual

Definition at line 62 of file ideal-wifi-manager.cc.

Member Function Documentation

void ns3::IdealWifiManager::AddModeSnrThreshold	(	WifiMode	mode,
		double	snr
	)

private

Adds a pair of WifiMode and the minimum SNR for that given mode to the list.

Parameters

mode	WifiMode
snr	the minimum SNR for the given mode

Definition at line 94 of file ideal-wifi-manager.cc.

References m_thresholds.

Referenced by SetupPhy().

Here is the caller graph for this function:

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

privatevirtual

Returns: a new station data structure

Implements ns3::WifiRemoteStationManager.

Definition at line 100 of file ideal-wifi-manager.cc.

References ns3::IdealWifiRemoteStation::m_lastSnr.

WifiTxVector ns3::IdealWifiManager::DoGetDataTxVector	(	WifiRemoteStation *	station,
		uint32_t	size
	)

privatevirtual

Parameters

station	the station that we need to communicate
size	size 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.

Implements ns3::WifiRemoteStationManager.

Definition at line 145 of file ideal-wifi-manager.cc.

Here is the call graph for this function:

WifiTxVector ns3::IdealWifiManager::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 167 of file ideal-wifi-manager.cc.

Here is the call graph for this function:

void ns3::IdealWifiManager::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 118 of file ideal-wifi-manager.cc.

void ns3::IdealWifiManager::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 129 of file ideal-wifi-manager.cc.

References ns3::IdealWifiRemoteStation::m_lastSnr.

void ns3::IdealWifiManager::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 140 of file ideal-wifi-manager.cc.

void ns3::IdealWifiManager::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 136 of file ideal-wifi-manager.cc.

void ns3::IdealWifiManager::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 114 of file ideal-wifi-manager.cc.

void ns3::IdealWifiManager::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 122 of file ideal-wifi-manager.cc.

References ns3::IdealWifiRemoteStation::m_lastSnr.

void ns3::IdealWifiManager::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 109 of file ideal-wifi-manager.cc.

double ns3::IdealWifiManager::GetSnrThreshold ( WifiMode mode ) const

private

Return the minimum SNR needed to successfully transmit data with this mode at the specified BER.

Parameters

mode WifiMode

Returns: the minimum SNR for the given mode

Definition at line 80 of file ideal-wifi-manager.cc.

References m_thresholds, and NS_ASSERT.

Referenced by DoGetDataTxVector(), and DoGetRtsTxVector().

Here is the caller graph for this function:

TypeId ns3::IdealWifiManager::GetTypeId ( void )

static

Definition at line 45 of file ideal-wifi-manager.cc.

References m_ber, and ns3::TypeId::SetParent().

Here is the call graph for this function:

bool ns3::IdealWifiManager::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 190 of file ideal-wifi-manager.cc.

void ns3::IdealWifiManager::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