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 <array>
#include "ns3/traced-callback.h"
#include "ns3/object.h"
#include "ns3/data-rate.h"
#include "ns3/mac48-address.h"
#include "wifi-mode.h"
#include "wifi-utils.h"
#include "qos-utils.h"
#include "wifi-remote-station-info.h"
#include "ht-capabilities.h"
#include "vht-capabilities.h"
#include "he-capabilities.h"

namespace ns3 {

class WifiPhy;
class WifiMac;
class WifiMacHeader;
class Packet;
class WifiTxVector;

struct WifiRemoteStationState;

struct WifiRemoteStation
{
  virtual ~WifiRemoteStation () {};
  WifiRemoteStationState *m_state;  
};

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;      
  Ptr<const HtCapabilities> m_htCapabilities;   
  Ptr<const VhtCapabilities> m_vhtCapabilities; 
  Ptr<const HeCapabilities> m_heCapabilities;   

  uint16_t m_channelWidth;    
  uint16_t m_guardInterval;   
  uint8_t m_ness;             
  bool m_aggregation;         
  bool m_shortPreamble;       
  bool m_shortSlotTime;       
  bool m_qosSupported;        
};

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

  WifiRemoteStationManager ();
  virtual ~WifiRemoteStationManager ();

  enum ProtectionMode
  {
    RTS_CTS,
    CTS_TO_SELF
  };

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

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

  void SetMaxSsrc (uint32_t maxSsrc);
  void SetMaxSlrc (uint32_t maxSlrc);
  void SetRtsCtsThreshold (uint32_t threshold);

  uint32_t GetFragmentationThreshold (void) const;
  void SetFragmentationThreshold (uint32_t threshold);
  void UpdateFragmentationThreshold (void);

  void SetQosSupport (Mac48Address from, bool qosSupported);
  void AddStationHtCapabilities (Mac48Address from, HtCapabilities htCapabilities);
  void AddStationVhtCapabilities (Mac48Address from, VhtCapabilities vhtCapabilities);
  void AddStationHeCapabilities (Mac48Address from, HeCapabilities heCapabilities);
  Ptr<const HtCapabilities> GetStationHtCapabilities (Mac48Address from);
  Ptr<const VhtCapabilities> GetStationVhtCapabilities (Mac48Address from);
  Ptr<const HeCapabilities> GetStationHeCapabilities (Mac48Address from);
  bool GetHtSupported (void) const;
  bool GetVhtSupported (void) const;
  bool GetHeSupported (void) const;
  void SetPcfSupported (bool enable);
  bool GetPcfSupported (void) const;
  bool GetGreenfieldSupported (void) const;
  bool GetShortGuardIntervalSupported (void) const;
  uint16_t GetGuardInterval (void) const;
  void SetUseNonErpProtection (bool enable);
  bool GetUseNonErpProtection (void) const;
  void SetUseNonHtProtection (bool enable);
  bool GetUseNonHtProtection (void) const;
  void SetUseGreenfieldProtection (bool enable);
  bool GetUseGreenfieldProtection (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;
  uint8_t GetNBasicModes (void) const;
  WifiMode GetBasicMode (uint8_t i) const;
  uint32_t GetNNonErpBasicModes (void) const;
  WifiMode GetNonErpBasicMode (uint8_t i) const;
  bool GetGreenfieldSupported (Mac48Address address) const;
  bool GetShortPreambleSupported (Mac48Address address) const;
  bool GetShortSlotTimeSupported (Mac48Address address) const;
  bool GetQosSupported (Mac48Address address) const;
  void AddBasicMcs (WifiMode mcs);
  WifiMode GetDefaultMcs (void) const;
  uint8_t GetNBasicMcs (void) const;
  WifiMode GetBasicMcs (uint8_t i) const;
  void AddSupportedMcs (Mac48Address address, WifiMode mcs);
  uint16_t GetChannelWidthSupported (Mac48Address address) const;
  bool GetShortGuardIntervalSupported (Mac48Address address) const;
  uint8_t GetNumberOfSupportedStreams (Mac48Address address) const;
  uint8_t GetNMcsSupported (Mac48Address address) const;
  bool GetHtSupported (Mac48Address address) const;
  bool GetVhtSupported (Mac48Address address) const;
  bool GetHeSupported (Mac48Address address) const;

  WifiMode GetNonUnicastMode (void) const;

  void AddSupportedMode (Mac48Address address, WifiMode mode);
  void AddAllSupportedModes (Mac48Address address);
  void AddAllSupportedMcs (Mac48Address address);
  void RemoveAllSupportedMcs (Mac48Address address);
  void AddSupportedPhyPreamble (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);

  WifiTxVector GetDataTxVector (const WifiMacHeader &header);
  WifiTxVector GetRtsTxVector (Mac48Address address);
  WifiTxVector GetCtsToSelfTxVector (void);

  void ReportRtsFailed (Mac48Address address, const WifiMacHeader *header);
  void ReportDataFailed (Mac48Address address, const WifiMacHeader *header,
                         uint32_t packetSize);
  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, WifiTxVector dataTxVector,
                     uint32_t packetSize);
  void ReportFinalRtsFailed (Mac48Address address, const WifiMacHeader *header);
  void ReportFinalDataFailed (Mac48Address address, const WifiMacHeader *header,
                              uint32_t packetSize);
  void ReportAmpduTxStatus (Mac48Address address, uint8_t nSuccessfulMpdus, uint8_t nFailedMpdus,
                            double rxSnr, double dataSnr, WifiTxVector dataTxVector);

  void ReportRxOk (Mac48Address address, double rxSnr, WifiMode txMode);

  bool NeedRts (const WifiMacHeader &header, uint32_t size);
  bool NeedCtsToSelf (WifiTxVector txVector);

  bool NeedRetransmission (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);

  uint8_t GetDefaultTxPowerLevel (void) const;
  WifiRemoteStationInfo GetInfo (Mac48Address address);
  void SetDefaultTxPowerLevel (uint8_t txPower);
  uint8_t GetNumberOfAntennas (void) const;
  uint8_t GetMaxNumberOfTransmitStreams (void) const;
  bool UseGreenfieldForDestination (Mac48Address dest) const;

  typedef void (*PowerChangeTracedCallback)(double oldPower, double newPower, Mac48Address remoteAddress);

  typedef void (*RateChangeTracedCallback)(DataRate oldRate, DataRate newRate, Mac48Address remoteAddress);


protected:
  virtual void DoDispose (void);
  WifiMode GetSupported (const WifiRemoteStation *station, uint8_t i) const;
  uint8_t GetNSupported (const WifiRemoteStation *station) const;
  bool GetQosSupported (const WifiRemoteStation *station) const;
  bool GetHtSupported (const WifiRemoteStation *station) const;
  bool GetVhtSupported (const WifiRemoteStation *station) const;
  bool GetHeSupported (const WifiRemoteStation *station) const;
  WifiMode GetMcsSupported (const WifiRemoteStation *station, uint8_t i) const;
  uint8_t GetNMcsSupported (const WifiRemoteStation *station) const;
  WifiMode GetNonErpSupported (const WifiRemoteStation *station, uint8_t i) const;
  uint32_t GetNNonErpSupported (const WifiRemoteStation *station) const;
  Mac48Address GetAddress (const WifiRemoteStation *station) const;
  uint16_t GetChannelWidth (const WifiRemoteStation *station) const;
  bool GetShortGuardIntervalSupported (const WifiRemoteStation *station) const;
  uint16_t GetGuardInterval (const WifiRemoteStation *station) const;
  bool GetAggregation (const WifiRemoteStation *station) const;
  bool GetGreenfield (const WifiRemoteStation *station) const;

  uint8_t GetNumberOfSupportedStreams (const WifiRemoteStation *station) const;
  uint8_t GetNess (const WifiRemoteStation *station) const;

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


private:
  virtual bool DoNeedRts (WifiRemoteStation *station,
                          uint32_t size, bool normally);
  virtual bool DoNeedRetransmission (WifiRemoteStation *station,
                                     Ptr<const Packet> packet, bool normally);
  virtual bool DoNeedFragmentation (WifiRemoteStation *station,
                                    Ptr<const Packet> packet, bool normally);
  virtual WifiRemoteStation* DoCreateStation (void) const = 0;
  virtual WifiTxVector DoGetDataTxVector (WifiRemoteStation *station) = 0;
  virtual WifiTxVector DoGetRtsTxVector (WifiRemoteStation *station) = 0;

  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, uint16_t dataChannelWidth, uint8_t dataNss) = 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, uint8_t nSuccessfulMpdus, uint8_t nFailedMpdus,
                                      double rxSnr, double dataSnr, uint16_t dataChannelWidth, uint8_t dataNss);

  WifiRemoteStationState* LookupState (Mac48Address address) const;
  WifiRemoteStation* Lookup (Mac48Address address) const;

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

  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_pcfSupported; 
  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_useNonHtProtection;      
  bool m_useGreenfieldProtection; 
  bool m_shortPreambleEnabled;    
  bool m_shortSlotTimeEnabled;    
  ProtectionMode m_erpProtectionMode; 
  ProtectionMode m_htProtectionMode;  

  std::array<uint32_t, AC_BE_NQOS> m_ssrc; 
  std::array<uint32_t, AC_BE_NQOS> m_slrc; 

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

} //namespace ns3

#endif /* WIFI_REMOTE_STATION_MANAGER_H */