wifi-remote-station-manager.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2005,2006,2007 INRIA
 *
 * 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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 */

#ifndef WIFI_REMOTE_STATION_MANAGER_H
#define WIFI_REMOTE_STATION_MANAGER_H

#include <vector>
#include <utility>
#include "ns3/mac48-address.h"
#include "ns3/traced-callback.h"
#include "ns3/packet.h"
#include "ns3/object.h"
#include "ns3/nstime.h"
#include "wifi-mode.h"
#include "wifi-tx-vector.h"
#include "ht-capabilities.h"
#include "vht-capabilities.h"

namespace ns3 {

struct WifiRemoteStation;
struct WifiRemoteStationState;
class WifiPhy;
class WifiMac;
class WifiMacHeader;

class WifiRemoteStationInfo
{
public:
  WifiRemoteStationInfo ();
  void NotifyTxSuccess (uint32_t retryCounter);
  void NotifyTxFailed ();
  double GetFrameErrorRate () const;
private:
  double CalculateAveragingCoefficient ();
  Time m_memoryTime;
  Time m_lastUpdate;
  double m_failAvg;
};

class WifiRemoteStationManager : public Object
{
public:
  static TypeId GetTypeId (void);

  WifiRemoteStationManager ();
  virtual ~WifiRemoteStationManager ();
  
  enum ProtectionMode
  {
    RTS_CTS,
    CTS_TO_SELF
  };

  virtual void SetupPhy (Ptr<WifiPhy> phy);
  virtual void SetupMac (Ptr<WifiMac> mac);

  uint32_t GetMaxSsrc (void) const;
  uint32_t GetMaxSlrc (void) const;
  uint32_t GetRtsCtsThreshold (void) const;
  uint32_t GetFragmentationThreshold (void) const;
  void SetMaxSsrc (uint32_t maxSsrc);
  void SetMaxSlrc (uint32_t maxSlrc);
  void SetRtsCtsThreshold (uint32_t threshold);
  void SetFragmentationThreshold (uint32_t threshold);
  void UpdateFragmentationThreshold (void);
  void AddStationHtCapabilities (Mac48Address from, HtCapabilities htcapabilities);
  void AddStationVhtCapabilities (Mac48Address from,VhtCapabilities vhtcapabilities);
  void SetHtSupported (bool enable);
  bool HasHtSupported (void) const;
  void SetVhtSupported (bool enable);
  bool HasVhtSupported (void) const;
  void SetProtectionMode (ProtectionMode mode);
  ProtectionMode GetProtectionMode (void) const;
  void SetUseNonErpProtection (bool enable);
  bool GetUseNonErpProtection (void) const;
  void SetShortPreambleEnabled (bool enable);
  bool GetShortPreambleEnabled (void) const;
  void SetShortSlotTimeEnabled (bool enable);
  bool GetShortSlotTimeEnabled (void) const;

  void Reset (void);

  void AddBasicMode (WifiMode mode);
  WifiMode GetDefaultMode (void) const;
  uint32_t GetNBasicModes (void) const;
  WifiMode GetBasicMode (uint32_t i) const;
  uint32_t GetNNonErpBasicModes (void) const;
  WifiMode GetNonErpBasicMode (uint32_t i) const;
  bool GetGreenfieldSupported (Mac48Address address) const;
  bool GetShortPreambleSupported (Mac48Address address) const;
  bool GetShortSlotTimeSupported (Mac48Address address) const;
  void AddBasicMcs (WifiMode mcs);
  WifiMode GetDefaultMcs (void) const;
  uint32_t GetNBasicMcs (void) const;
  WifiMode GetBasicMcs (uint32_t i) const;
  void AddSupportedMcs (Mac48Address address, WifiMode mcs);

  WifiMode GetNonUnicastMode (void) const;

  void Reset (Mac48Address address);

  void AddSupportedMode (Mac48Address address, WifiMode mode);
  void AddAllSupportedModes (Mac48Address address);
  void AddAllSupportedMcs (Mac48Address address);
  void AddSupportedPlcpPreamble (Mac48Address address, bool isShortPreambleSupported);
  void AddSupportedErpSlotTime (Mac48Address address, bool isShortSlotTimeSupported);
  bool IsBrandNew (Mac48Address address) const;
  bool IsAssociated (Mac48Address address) const;
  bool IsWaitAssocTxOk (Mac48Address address) const;
  void RecordWaitAssocTxOk (Mac48Address address);
  void RecordGotAssocTxOk (Mac48Address address);
  void RecordGotAssocTxFailed (Mac48Address address);
  void RecordDisassociated (Mac48Address address);

  void PrepareForQueue (Mac48Address address, const WifiMacHeader *header,
                        Ptr<const Packet> packet);

  WifiTxVector GetDataTxVector (Mac48Address address, const WifiMacHeader *header,
                                Ptr<const Packet> packet);
  WifiTxVector GetRtsTxVector (Mac48Address address, const WifiMacHeader *header,
                               Ptr<const Packet> packet);
  WifiTxVector GetCtsToSelfTxVector (const WifiMacHeader *header,
                                     Ptr<const Packet> packet);
  WifiTxVector DoGetCtsToSelfTxVector (void);

  void ReportRtsFailed (Mac48Address address, const WifiMacHeader *header);
  void ReportDataFailed (Mac48Address address, const WifiMacHeader *header);
  void ReportRtsOk (Mac48Address address, const WifiMacHeader *header,
                    double ctsSnr, WifiMode ctsMode, double rtsSnr);
  void ReportDataOk (Mac48Address address, const WifiMacHeader *header,
                     double ackSnr, WifiMode ackMode, double dataSnr);
  void ReportFinalRtsFailed (Mac48Address address, const WifiMacHeader *header);
  void ReportFinalDataFailed (Mac48Address address, const WifiMacHeader *header);
  void ReportAmpduTxStatus (Mac48Address address, uint8_t tid, uint32_t nSuccessfulMpdus, uint32_t nFailedMpdus, double rxSnr, double dataSnr);

  void ReportRxOk (Mac48Address address, const WifiMacHeader *header,
                   double rxSnr, WifiMode txMode);

  bool NeedRts (Mac48Address address, const WifiMacHeader *header,
                Ptr<const Packet> packet, WifiTxVector txVector);
  bool NeedCtsToSelf (WifiTxVector txVector);

  bool NeedRtsRetransmission (Mac48Address address, const WifiMacHeader *header,
                              Ptr<const Packet> packet);
  bool NeedDataRetransmission (Mac48Address address, const WifiMacHeader *header,
                               Ptr<const Packet> packet);
  bool NeedFragmentation (Mac48Address address, const WifiMacHeader *header,
                          Ptr<const Packet> packet);
  uint32_t GetFragmentSize (Mac48Address address, const WifiMacHeader *header,
                            Ptr<const Packet> packet, uint32_t fragmentNumber);
  uint32_t GetFragmentOffset (Mac48Address address, const WifiMacHeader *header,
                              Ptr<const Packet> packet, uint32_t fragmentNumber);
  bool IsLastFragment (Mac48Address address, const WifiMacHeader *header,
                       Ptr<const Packet> packet, uint32_t fragmentNumber);

  WifiTxVector GetCtsTxVector (Mac48Address address, WifiMode rtsMode);
  WifiTxVector GetAckTxVector (Mac48Address address, WifiMode dataMode);
  WifiTxVector GetBlockAckTxVector (Mac48Address address, WifiMode dataMode);
  uint8_t GetDefaultTxPowerLevel (void) const;
  WifiRemoteStationInfo GetInfo (Mac48Address address);
  void SetDefaultTxPowerLevel (uint8_t txPower);
  uint32_t GetNumberOfTransmitAntennas (void);

  typedef void (*PowerChangeTracedCallback)(uint8_t power, Mac48Address remoteAddress);

  typedef void (*RateChangeTracedCallback)(uint32_t rate, Mac48Address remoteAddress);



protected:
  virtual void DoDispose (void);
  WifiMode GetSupported (const WifiRemoteStation *station, uint32_t i) const;
  uint32_t GetNSupported (const WifiRemoteStation *station) const;
  bool GetHtSupported (const WifiRemoteStation *station) const;
  bool GetVhtSupported (const WifiRemoteStation *station) const;
  WifiMode GetMcsSupported (const WifiRemoteStation *station, uint32_t i) const;
  uint32_t GetNMcsSupported (const WifiRemoteStation *station) const;
  WifiMode GetNonErpSupported (const WifiRemoteStation *station, uint32_t i) const;
  uint32_t GetNNonErpSupported (const WifiRemoteStation *station) const;
  uint32_t GetChannelWidth (const WifiRemoteStation *station) const;
  bool GetShortGuardInterval (const WifiRemoteStation *station) const;
  bool GetAggregation (const WifiRemoteStation *station) const;
  bool GetStbc (const WifiRemoteStation *station) const;
  bool GetGreenfield (const WifiRemoteStation *station) const;

  uint8_t GetNumberOfSupportedRxAntennas (const WifiRemoteStation *station) const;
  uint32_t GetNess (const WifiRemoteStation *station) const;
  uint32_t GetLongRetryCount (const WifiRemoteStation *station) const;
  uint32_t GetShortRetryCount (const WifiRemoteStation *station) const;

  Ptr<WifiPhy> GetPhy (void) const;
  Ptr<WifiMac> GetMac (void) const;


private:
  virtual bool DoNeedRts (WifiRemoteStation *station,
                          Ptr<const Packet> packet, bool normally);
  virtual bool DoNeedRtsRetransmission (WifiRemoteStation *station,
                                        Ptr<const Packet> packet, bool normally);
  virtual bool DoNeedDataRetransmission (WifiRemoteStation *station,
                                         Ptr<const Packet> packet, bool normally);
  virtual bool DoNeedFragmentation (WifiRemoteStation *station,
                                    Ptr<const Packet> packet, bool normally);
  virtual bool IsLowLatency (void) const = 0;
  virtual WifiRemoteStation* DoCreateStation (void) const = 0;
  virtual WifiTxVector DoGetDataTxVector (WifiRemoteStation *station) = 0;
  virtual WifiTxVector DoGetRtsTxVector (WifiRemoteStation *station) = 0;
  virtual uint8_t DoGetCtsTxPowerLevel (Mac48Address address, WifiMode ctsMode);
  virtual uint8_t DoGetAckTxPowerLevel (Mac48Address address, WifiMode ackMode);
  virtual uint8_t DoGetBlockAckTxPowerLevel (Mac48Address address, WifiMode blockAckMode);

  virtual uint32_t DoGetCtsTxChannelWidth (Mac48Address address, WifiMode ctsMode);
  virtual bool DoGetCtsTxGuardInterval (Mac48Address address, WifiMode ctsMode);
  virtual uint8_t DoGetCtsTxNss (Mac48Address address, WifiMode ctsMode);
  virtual uint8_t DoGetCtsTxNess (Mac48Address address, WifiMode ctsMode);
  virtual bool  DoGetCtsTxStbc (Mac48Address address, WifiMode ctsMode);
  virtual uint32_t DoGetAckTxChannelWidth (Mac48Address address, WifiMode ctsMode);
  virtual bool DoGetAckTxGuardInterval (Mac48Address address, WifiMode ackMode);
  virtual uint8_t DoGetAckTxNss (Mac48Address address, WifiMode ackMode);
  virtual uint8_t DoGetAckTxNess (Mac48Address address, WifiMode ackMode);
  virtual bool DoGetAckTxStbc (Mac48Address address, WifiMode ackMode);
  virtual uint32_t DoGetBlockAckTxChannelWidth (Mac48Address address, WifiMode ctsMode);
  virtual bool DoGetBlockAckTxGuardInterval (Mac48Address address, WifiMode blockAckMode);
  virtual uint8_t DoGetBlockAckTxNss (Mac48Address address, WifiMode blockAckMode);
  virtual uint8_t DoGetBlockAckTxNess (Mac48Address address, WifiMode blockAckMode);
  virtual bool DoGetBlockAckTxStbc (Mac48Address address, WifiMode blockAckMode);

  virtual void DoReportRtsFailed (WifiRemoteStation *station) = 0;
  virtual void DoReportDataFailed (WifiRemoteStation *station) = 0;
  virtual void DoReportRtsOk (WifiRemoteStation *station,
                              double ctsSnr, WifiMode ctsMode, double rtsSnr) = 0;
  virtual void DoReportDataOk (WifiRemoteStation *station,
                               double ackSnr, WifiMode ackMode, double dataSnr) = 0;
  virtual void DoReportFinalRtsFailed (WifiRemoteStation *station) = 0;
  virtual void DoReportFinalDataFailed (WifiRemoteStation *station) = 0;
  virtual void DoReportRxOk (WifiRemoteStation *station,
                             double rxSnr, WifiMode txMode) = 0;
  virtual void DoReportAmpduTxStatus (WifiRemoteStation *station, uint32_t nSuccessfulMpdus, uint32_t nFailedMpdus, double rxSnr, double dataSnr);

  WifiRemoteStationState* LookupState (Mac48Address address) const;
  WifiRemoteStation* Lookup (Mac48Address address, uint8_t tid) const;

  WifiRemoteStation* Lookup (Mac48Address address, const WifiMacHeader *header) const;

  bool IsAllowedControlAnswerModulationClass (enum WifiModulationClass modClassReq, enum WifiModulationClass modClassAnswer) const;

  WifiMode GetControlAnswerMode (Mac48Address address, WifiMode reqMode);

  void DoSetFragmentationThreshold (uint32_t threshold);
  uint32_t DoGetFragmentationThreshold (void) const;
  uint32_t GetNFragments (const WifiMacHeader *header, Ptr<const Packet> packet);

  typedef std::vector <WifiRemoteStation *> Stations;
  typedef std::vector <WifiRemoteStationState *> StationStates;

  Ptr<WifiPhy> m_wifiPhy;
  Ptr<WifiMac> m_wifiMac;

  WifiModeList m_bssBasicRateSet;
  WifiModeList m_bssBasicMcsSet;

  StationStates m_states;  
  Stations m_stations;     

  WifiMode m_defaultTxMode; 
  WifiMode m_defaultTxMcs;   

  bool m_htSupported;  
  bool m_vhtSupported; 
  uint32_t m_maxSsrc;  
  uint32_t m_maxSlrc;  
  uint32_t m_rtsCtsThreshold;  
  uint32_t m_fragmentationThreshold;  
  uint32_t m_nextFragmentationThreshold;  
  uint8_t m_defaultTxPowerLevel;  
  WifiMode m_nonUnicastMode;  
  bool m_useNonErpProtection; 
  bool m_shortPreambleEnabled; 
  bool m_shortSlotTimeEnabled; 
  ProtectionMode m_protectionMode; 

  TracedCallback<Mac48Address> m_macTxRtsFailed;
  TracedCallback<Mac48Address> m_macTxDataFailed;
  TracedCallback<Mac48Address> m_macTxFinalRtsFailed;
  TracedCallback<Mac48Address> m_macTxFinalDataFailed;
};

struct WifiRemoteStationState
{
  enum
  {
    BRAND_NEW,
    DISASSOC,
    WAIT_ASSOC_TX_OK,
    GOT_ASSOC_TX_OK
  } m_state;

  WifiModeList m_operationalRateSet;
  WifiModeList m_operationalMcsSet;
  Mac48Address m_address;  
  WifiRemoteStationInfo m_info;

  uint32_t m_channelWidth;    
  bool m_shortGuardInterval;  
  uint8_t m_rx;               
  uint32_t m_ness;            
  bool m_stbc;                
  bool m_aggregation;         
  bool m_greenfield;          
  bool m_shortPreamble;       
  bool m_shortSlotTime;       
  bool m_htSupported;         
  bool m_vhtSupported;        
};

struct WifiRemoteStation
{
  virtual ~WifiRemoteStation ();
  WifiRemoteStationState *m_state;  
  uint32_t m_ssrc;                  
  uint32_t m_slrc;                  
  uint8_t m_tid;                    
};

} //namespace ns3

#endif /* WIFI_REMOTE_STATION_MANAGER_H */