minstrel-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
 *
 * 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>
 *         Matías Richart <mrichart@fing.edu.uy>
 */

#ifndef MINSTREL_WIFI_MANAGER_H
#define MINSTREL_WIFI_MANAGER_H

#include "wifi-remote-station-manager.h"
#include "wifi-mode.h"
#include "ns3/nstime.h"
#include "ns3/random-variable-stream.h"
#include <fstream>

namespace ns3 {

struct RateInfo
{
  Time perfectTxTime;

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

  uint32_t ewmaProb;
  uint32_t throughput;  

  uint32_t prevNumRateAttempt;  
  uint32_t prevNumRateSuccess;  
  uint64_t successHist;         
  uint64_t attemptHist;         

  uint8_t numSamplesSkipped;
  int sampleLimit;
};

typedef std::vector<struct RateInfo> MinstrelRate;
typedef std::vector<std::vector<uint32_t> > SampleRate;

struct MinstrelWifiRemoteStation : public WifiRemoteStation
{
  Time m_nextStatsUpdate;  

  uint32_t m_col, m_index;
  uint32_t m_maxTpRate;          
  uint32_t m_maxTpRate2;         
  uint32_t m_maxProbRate;        
  uint32_t m_nModes;             
  int m_totalPacketsCount;             
  int m_samplePacketsCount;             
  int m_numSamplesDeferred;
  bool m_isSampling;             
  uint32_t m_sampleRate;         
  bool  m_sampleDeferred;        
  uint32_t m_shortRetry;         
  uint32_t m_longRetry;          
  uint32_t m_retry;              
  uint32_t m_txrate;             
  bool m_initialized;            
  MinstrelRate m_minstrelTable;  
  SampleRate m_sampleTable;      
  std::ofstream m_statsFile;
};


class MinstrelWifiManager : public WifiRemoteStationManager
{

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

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

  int64_t AssignStreams (int64_t stream);

  void UpdateRate (MinstrelWifiRemoteStation *station);

  //updating the Minstrel Table every 1/10 seconds
  void UpdateStats (MinstrelWifiRemoteStation *station);

  //find a rate to use from Minstrel Table
  uint32_t FindRate (MinstrelWifiRemoteStation *station);

  WifiTxVector GetDataTxVector (MinstrelWifiRemoteStation *station);

  WifiTxVector GetRtsTxVector (MinstrelWifiRemoteStation *station);

  uint32_t CountRetries (MinstrelWifiRemoteStation *station);

  void UpdatePacketCounters (MinstrelWifiRemoteStation *station);

  //update the number of retries and reset accordingly
  void UpdateRetry (MinstrelWifiRemoteStation *station);

  void CheckInit (MinstrelWifiRemoteStation *station);  

  //initialize Sample Table
  void InitSampleTable (MinstrelWifiRemoteStation *station);

private:
  //overriden from base class
  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 bool DoNeedDataRetransmission (WifiRemoteStation *st, Ptr<const Packet> packet, bool normally);

  virtual bool IsLowLatency (void) const;

  //for estimating the TxTime of a packet with a given mode
  Time GetCalcTxTime (WifiMode mode) const;
  void AddCalcTxTime (WifiMode mode, Time t);

  //initialize Minstrel Table
  void RateInit (MinstrelWifiRemoteStation *station);

  //getting the next sample from Sample Table
  uint32_t GetNextSample (MinstrelWifiRemoteStation *station);

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

  //printing Sample Table
  void PrintSampleTable (MinstrelWifiRemoteStation *station);

  //printing Minstrel Table
  void PrintTable (MinstrelWifiRemoteStation *station);


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

  TxTime m_calcTxTime;      
  Time m_updateStats;       
  double m_lookAroundRate;  
  double m_ewmaLevel;       
  uint32_t m_sampleCol;     
  uint32_t m_pktLen;        
  bool m_printStats;        

  //Provides uniform random variables.
  Ptr<UniformRandomVariable> m_uniformRandomVariable;
};

} //namespace ns3

#endif /* MINSTREL_WIFI_MANAGER_H */