minstrel-ht-wifi-manager.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2009 Duy Nguyen
 * Copyright (c) 2015 Ghada Badawy
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *Author: Duy Nguyen <duy@soe.ucsc.edu>
 *        Ghada Badawy <gbadawy@gmail.com>
 *        Matias Richart <mrichart@fing.edu.uy>
 *
 * MinstrelHt is a rate adaptation algorithm for high-throughput (HT) 802.11
 */

#ifndef MINSTREL_HT_WIFI_MANAGER_H
#define MINSTREL_HT_WIFI_MANAGER_H

#include "wifi-remote-station-manager.h"
#include "minstrel-wifi-manager.h"
#include "wifi-mode.h"
#include "ns3/nstime.h"
#include "ns3/random-variable-stream.h"
#include <vector>
#include <map>
#include <deque>

namespace ns3 {

typedef std::vector<std::pair<Time, WifiMode> > TxTime;

struct McsGroup
{
  uint8_t streams;
  uint8_t sgi;
  uint32_t chWidth;
  bool isVht;
  bool isSupported;

  // To accurately account for TX times, we separate the TX time of the first
  // MPDU in an A-MPDU from the rest of the MPDUs.
  TxTime ratesTxTimeTable;
  TxTime ratesFirstMpduTxTimeTable;
};

typedef std::vector<struct McsGroup> MinstrelMcsGroups;

struct MinstrelHtWifiRemoteStation;
struct HtRateInfo
{
  Time perfectTxTime;

  bool supported;               

  uint32_t mcsIndex;            

  uint32_t retryCount;          
  uint32_t adjustedRetryCount;  
  uint32_t numRateAttempt;      
  uint32_t numRateSuccess;      
  double prob;                  

  bool retryUpdated;            

  double ewmaProb;

  double ewmsdProb;             

  uint32_t prevNumRateAttempt;  
  uint32_t prevNumRateSuccess;  
  uint32_t numSamplesSkipped;   
  uint64_t successHist;         
  uint64_t attemptHist;         
  double throughput;            
};

typedef std::vector<struct HtRateInfo> HtMinstrelRate;

struct GroupInfo
{
  uint8_t m_col;                  
  uint8_t m_index;                

  bool m_supported;               

  uint32_t m_maxTpRate;           
  uint32_t m_maxTpRate2;          
  uint32_t m_maxProbRate;         

  HtMinstrelRate m_ratesTable;    
};

typedef std::vector<struct GroupInfo> McsGroupData;

typedef std::vector<std::vector<uint32_t> > HtSampleRate;

static const uint8_t MAX_SUPPORTED_STREAMS = 4;  
static const uint8_t MAX_HT_STREAM_GROUPS = 4;   
static const uint8_t MAX_VHT_STREAM_GROUPS = 8;  
static const uint8_t MAX_HT_GROUP_RATES = 8;     
static const uint8_t MAX_VHT_GROUP_RATES = 10;   
static const uint8_t MAX_HT_WIDTH = 40;          
static const uint8_t MAX_VHT_WIDTH = 160;        

class MinstrelHtWifiManager : public WifiRemoteStationManager
{

public:
  static TypeId GetTypeId (void);
  MinstrelHtWifiManager ();
  virtual ~MinstrelHtWifiManager ();

  int64_t AssignStreams (int64_t stream);

  // Inherited from WifiRemoteStationManager
  virtual void SetupPhy (Ptr<WifiPhy> phy);
  virtual void SetupMac (Ptr<WifiMac> mac);

  typedef void (*RateChangeTracedCallback)(const uint64_t rate, const Mac48Address remoteAddress);

private:
  // Overriden from base class.
  virtual void DoInitialize (void);
  virtual WifiRemoteStation * DoCreateStation (void) const;
  virtual void DoReportRxOk (WifiRemoteStation *station,
                             double rxSnr, WifiMode txMode);
  virtual void DoReportRtsFailed (WifiRemoteStation *station);
  virtual void DoReportDataFailed (WifiRemoteStation *station);
  virtual void DoReportRtsOk (WifiRemoteStation *station,
                              double ctsSnr, WifiMode ctsMode, double rtsSnr);
  virtual void DoReportDataOk (WifiRemoteStation *station,
                               double ackSnr, WifiMode ackMode, double dataSnr);
  virtual void DoReportFinalRtsFailed (WifiRemoteStation *station);
  virtual void DoReportFinalDataFailed (WifiRemoteStation *station);
  virtual WifiTxVector DoGetDataTxVector (WifiRemoteStation *station);
  virtual WifiTxVector DoGetRtsTxVector (WifiRemoteStation *station);
  virtual void DoReportAmpduTxStatus (WifiRemoteStation *station, uint32_t nSuccessfulMpdus, uint32_t nFailedMpdus, double rxSnr, double dataSnr);
  virtual bool IsLowLatency (void) const;
  virtual bool DoNeedDataRetransmission (WifiRemoteStation *st, Ptr<const Packet> packet, bool normally);
  virtual void DoDisposeStation (WifiRemoteStation *station);

  bool IsValidMcs (Ptr<WifiPhy> phy, uint8_t streams, uint32_t chWidth, WifiMode mode);

  Time CalculateMpduTxDuration (Ptr<WifiPhy> phy, uint8_t streams, uint8_t sgi, uint32_t chWidth, WifiMode mode);

  Time CalculateFirstMpduTxDuration (Ptr<WifiPhy> phy, uint8_t streams, uint8_t sgi, uint32_t chWidth, WifiMode mode);

  Time GetMpduTxTime (uint32_t groupId, WifiMode mode) const;

  void AddMpduTxTime (uint32_t groupId, WifiMode mode, Time t);

  Time GetFirstMpduTxTime (uint32_t groupId, WifiMode mode) const;

  void AddFirstMpduTxTime (uint32_t groupId, WifiMode mode, Time t);

  void UpdateRetry (MinstrelHtWifiRemoteStation *station);

  void UpdatePacketCounters (MinstrelHtWifiRemoteStation *station, uint32_t nSuccessfulMpdus, uint32_t nFailedMpdus);

  uint32_t GetNextSample (MinstrelHtWifiRemoteStation *station);

  void SetNextSample (MinstrelHtWifiRemoteStation *station);

  uint32_t FindRate (MinstrelHtWifiRemoteStation *station);

  void UpdateStats (MinstrelHtWifiRemoteStation *station);

  void RateInit (MinstrelHtWifiRemoteStation *station);

  double CalculateThroughput (MinstrelHtWifiRemoteStation *station, uint32_t groupId, uint32_t rateId, double ewmaProb);

  void SetBestStationThRates (MinstrelHtWifiRemoteStation *station, uint32_t index);

  void SetBestProbabilityRate (MinstrelHtWifiRemoteStation *station, uint32_t index);

  void CalculateRetransmits (MinstrelHtWifiRemoteStation *station, uint32_t index);

  void CalculateRetransmits (MinstrelHtWifiRemoteStation *station, uint32_t groupId, uint32_t rateId);

  Time CalculateTimeUnicastPacket (Time dataTransmissionTime, uint32_t shortRetries, uint32_t longRetries);

  double CalculateEwmsd (double oldEwmsd, double currentProb, double ewmaProb, uint32_t weight);

  void InitSampleTable (MinstrelHtWifiRemoteStation *station);

  void PrintSampleTable (MinstrelHtWifiRemoteStation *station);

  void PrintTable (MinstrelHtWifiRemoteStation *station);

  void StatsDump (MinstrelHtWifiRemoteStation *station, uint32_t index, std::ofstream &of);

  void CheckInit (MinstrelHtWifiRemoteStation *station);

  uint32_t CountRetries (MinstrelHtWifiRemoteStation * station);

  void UpdateRate (MinstrelHtWifiRemoteStation *station);

  uint32_t GetRateId (uint32_t index);

  uint32_t GetGroupId (uint32_t index);

  uint32_t GetIndex (uint32_t groupId, uint32_t rateId);

  uint32_t GetHtGroupId (uint8_t txstreams, uint8_t sgi, uint32_t chWidth);

  uint32_t GetVhtGroupId (uint8_t txstreams, uint8_t sgi, uint32_t chWidth);

  uint32_t GetLowestIndex (MinstrelHtWifiRemoteStation *station);

  uint32_t GetLowestIndex (MinstrelHtWifiRemoteStation *station, uint32_t groupId);

  WifiModeList GetVhtDeviceMcsList (void) const;

  WifiModeList GetHtDeviceMcsList (void) const;

  Time m_updateStats;         
  double m_lookAroundRate;    
  double m_ewmaLevel;         

  uint32_t m_nSampleCol;      
  uint32_t m_frameLength;     


  uint8_t m_numGroups;         
  uint8_t m_numRates;          

  bool m_useVhtOnly;           

  bool m_printStats;           


  MinstrelMcsGroups m_minstrelGroups;                 

  Ptr<MinstrelWifiManager> m_legacyManager;           


  Ptr<UniformRandomVariable> m_uniformRandomVariable; 

  TracedCallback<uint64_t, Mac48Address> m_rateChange;
};

} // namespace ns3

#endif /* MINSTREL_HT_WIFI_MANAGER_H */