A Discrete-Event Network Simulator
API
minstrel-wifi-manager.h
Go to the documentation of this file.
1/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2009 Duy Nguyen
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation;
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 *
18 * Authors: Duy Nguyen <duy@soe.ucsc.edu>
19 * Matías Richart <mrichart@fing.edu.uy>
20 */
21
22#ifndef MINSTREL_WIFI_MANAGER_H
23#define MINSTREL_WIFI_MANAGER_H
24
25#include "ns3/traced-value.h"
26#include "ns3/wifi-remote-station-manager.h"
27#include <fstream>
28#include <map>
29
30namespace ns3 {
31
32class UniformRandomVariable;
33
38{
44
56
59 uint64_t successHist;
60 uint64_t attemptHist;
61
64};
65
70typedef std::vector<RateInfo> MinstrelRate;
75typedef std::vector<std::vector<uint8_t> > SampleRate;
76
84{
86
93 uint8_t m_col;
94 uint8_t m_index;
95 uint16_t m_maxTpRate;
96 uint16_t m_maxTpRate2;
97 uint16_t m_maxProbRate;
98 uint8_t m_nModes;
103 uint16_t m_sampleRate;
108 uint16_t m_txrate;
112 std::ofstream m_statsFile;
113};
114
115
158{
159public:
164 static TypeId GetTypeId (void);
166 virtual ~MinstrelWifiManager ();
167
168 void SetupPhy (const Ptr<WifiPhy> phy) override;
169 void SetupMac (const Ptr<WifiMac> mac) override;
170 int64_t AssignStreams (int64_t stream) override;
171
178
185
192 uint16_t FindRate (MinstrelWifiRemoteStation *station);
193
201
209
217
224
231
237 void CheckInit (MinstrelWifiRemoteStation *station);
238
245
246private:
247 void DoInitialize (void) override;
248 WifiRemoteStation * DoCreateStation (void) const override;
249 void DoReportRxOk (WifiRemoteStation *station,
250 double rxSnr, WifiMode txMode) override;
251 void DoReportRtsFailed (WifiRemoteStation *station) override;
252 void DoReportDataFailed (WifiRemoteStation *station) override;
253 void DoReportRtsOk (WifiRemoteStation *station,
254 double ctsSnr, WifiMode ctsMode, double rtsSnr) override;
255 void DoReportDataOk (WifiRemoteStation *station, double ackSnr, WifiMode ackMode,
256 double dataSnr, uint16_t dataChannelWidth, uint8_t dataNss) override;
257 void DoReportFinalRtsFailed (WifiRemoteStation *station) override;
258 void DoReportFinalDataFailed (WifiRemoteStation *station) override;
261
263 Ptr<const Packet> packet, bool normally) override;
264
265
272 Time GetCalcTxTime (WifiMode mode) const;
279 void AddCalcTxTime (WifiMode mode, Time t);
280
286 void RateInit (MinstrelWifiRemoteStation *station);
287
294 uint16_t GetNextSample (MinstrelWifiRemoteStation *station);
295
317 Time CalculateTimeUnicastPacket (Time dataTransmissionTime, uint32_t shortRetries, uint32_t longRetries);
318
325
332
338 typedef std::map<WifiMode, Time> TxTime;
339
343 uint8_t m_ewmaLevel;
344 uint8_t m_sampleCol;
348
351
353};
354
355} //namespace ns3
356
357#endif /* MINSTREL_WIFI_MANAGER_H */
Implementation of Minstrel Rate Control Algorithm.
WifiTxVector DoGetRtsTxVector(WifiRemoteStation *station) override
uint8_t m_lookAroundRate
the % to try other rates than our current rate
void AddCalcTxTime(WifiMode mode, Time t)
Add transmission time for the given mode to an internal list.
void PrintSampleTable(MinstrelWifiRemoteStation *station)
Print Sample Table.
void RateInit(MinstrelWifiRemoteStation *station)
Initialize Minstrel Table.
uint32_t m_pktLen
packet length used for calculate mode TxTime
void DoReportFinalDataFailed(WifiRemoteStation *station) override
This method is a pure virtual method that must be implemented by the sub-class.
void DoInitialize(void) override
Initialize() implementation.
void UpdateStats(MinstrelWifiRemoteStation *station)
Update the Minstrel Table.
void CheckInit(MinstrelWifiRemoteStation *station)
Check for initializations.
Ptr< UniformRandomVariable > m_uniformRandomVariable
Provides uniform random variables.
TxTime m_calcTxTime
to hold all the calculated TxTime for all modes
WifiTxVector DoGetDataTxVector(WifiRemoteStation *station) override
bool m_printSamples
whether samples table should be printed.
void DoReportDataFailed(WifiRemoteStation *station) override
This method is a pure virtual method that must be implemented by the sub-class.
bool m_printStats
whether statistics table should be printed.
WifiTxVector GetRtsTxVector(MinstrelWifiRemoteStation *station)
Get RTS transmit vector.
static TypeId GetTypeId(void)
Get the type ID.
uint8_t m_sampleCol
number of sample columns
void DoReportFinalRtsFailed(WifiRemoteStation *station) override
This method is a pure virtual method that must be implemented by the sub-class.
void SetupMac(const Ptr< WifiMac > mac) override
Set up MAC associated with this device since it is the object that knows the full set of timing param...
uint16_t FindRate(MinstrelWifiRemoteStation *station)
Find a rate to use from Minstrel Table.
Time GetCalcTxTime(WifiMode mode) const
Estimate the TxTime of a packet with a given mode.
Time CalculateTimeUnicastPacket(Time dataTransmissionTime, uint32_t shortRetries, uint32_t longRetries)
Estimate the time to transmit the given packet with the given number of retries.
void DoReportRtsOk(WifiRemoteStation *station, double ctsSnr, WifiMode ctsMode, double rtsSnr) override
This method is a pure virtual method that must be implemented by the sub-class.
void InitSampleTable(MinstrelWifiRemoteStation *station)
Initialize Sample Table.
TracedValue< uint64_t > m_currentRate
Trace rate changes.
Time m_updateStats
how frequent do we calculate the stats
bool DoNeedRetransmission(WifiRemoteStation *st, Ptr< const Packet > packet, bool normally) override
std::map< WifiMode, Time > TxTime
typedef for a vector of a pair of Time, WifiMode.
void UpdatePacketCounters(MinstrelWifiRemoteStation *station)
Update packet counters.
void UpdateRate(MinstrelWifiRemoteStation *station)
Update the rate.
void DoReportDataOk(WifiRemoteStation *station, double ackSnr, WifiMode ackMode, double dataSnr, uint16_t dataChannelWidth, uint8_t dataNss) override
This method is a pure virtual method that must be implemented by the sub-class.
WifiRemoteStation * DoCreateStation(void) const override
void PrintTable(MinstrelWifiRemoteStation *station)
Print Minstrel Table.
uint16_t GetNextSample(MinstrelWifiRemoteStation *station)
Get the next sample from Sample Table.
int64_t AssignStreams(int64_t stream) override
Assign a fixed random variable stream number to the random variables used by this model.
void DoReportRtsFailed(WifiRemoteStation *station) override
This method is a pure virtual method that must be implemented by the sub-class.
void DoReportRxOk(WifiRemoteStation *station, double rxSnr, WifiMode txMode) override
This method is a pure virtual method that must be implemented by the sub-class.
uint8_t m_ewmaLevel
exponential weighted moving average
void SetupPhy(const Ptr< WifiPhy > phy) override
Set up PHY associated with this device since it is the object that knows the full set of transmit rat...
uint32_t CountRetries(MinstrelWifiRemoteStation *station)
Get the number of retries.
void UpdateRetry(MinstrelWifiRemoteStation *station)
Update the number of retries and reset accordingly.
WifiTxVector GetDataTxVector(MinstrelWifiRemoteStation *station)
Get data transmit vector.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:104
a unique identifier for an interface.
Definition: type-id.h:59
represent a single transmission mode
Definition: wifi-mode.h:48
hold a list of per-remote-station state.
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
Every class exported by the ns3 library is enclosed in the ns3 namespace.
std::vector< RateInfo > MinstrelRate
Data structure for a Minstrel Rate table A vector of a struct RateInfo.
std::vector< std::vector< uint8_t > > SampleRate
Data structure for a Sample Rate table A vector of a vector uint8_t.
mac
Definition: third.py:87
phy
Definition: third.py:84
hold per-remote-station state for Minstrel Wifi manager.
uint16_t m_maxTpRate2
second highest throughput rate in bps
Time m_nextStatsUpdate
10 times every second
bool m_initialized
for initializing tables
uint16_t m_sampleRate
current sample rate in bps
int m_numSamplesDeferred
number samples deferred
uint16_t m_txrate
current transmit rate in bps
int m_totalPacketsCount
total number of packets as of now
bool m_isSampling
a flag to indicate we are currently sampling
MinstrelRate m_minstrelTable
minstrel table
uint32_t m_shortRetry
short retries such as control packets
uint32_t m_retry
total retries short + long
uint16_t m_maxTpRate
the current throughput rate in bps
bool m_sampleDeferred
a flag to indicate sample rate is on the second stage
uint8_t m_nModes
number of modes supported
SampleRate m_sampleTable
sample table
int m_samplePacketsCount
how many packets we have sample so far
std::ofstream m_statsFile
stats file
uint8_t m_col
To keep track of the current position in the our random sample table going row by row from 1st column...
uint32_t m_longRetry
long retries such as data packets
uint16_t m_maxProbRate
rate with highest probability of success in bps
A struct to contain all information related to a data rate.
uint8_t numSamplesSkipped
number of samples skipped
uint32_t ewmaProb
EWMA calculation ewma_prob =[prob *(100 - ewma_level) + (ewma_prob_old * ewma_level)]/100.
uint32_t numRateSuccess
number of successful packets
uint32_t adjustedRetryCount
adjust the retry limit for this rate
uint32_t prevNumRateSuccess
Number of successful frames transmitted with previous rate.
int sampleLimit
sample limit
uint32_t prob
(# packets success)/(# total packets)
uint32_t retryCount
retry limit
Time perfectTxTime
Perfect transmission time calculation, or frame calculation Given a bit rate and a packet length n by...
uint64_t successHist
Aggregate of all transmission successes.
uint32_t throughput
throughput of a rate in bps
uint32_t prevNumRateAttempt
Number of transmission attempts with previous rate.
uint32_t numRateAttempt
how many number of attempts so far
uint64_t attemptHist
Aggregate of all transmission attempts.
hold per-remote-station state.