wifi-remote-station-manager.h

/* -*- 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"

namespace ns3 {

struct WifiRemoteStation;
struct WifiRemoteStationState;
class WifiPhy;
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 ();

  virtual void SetupPhy (Ptr<WifiPhy> phy);

  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);

  // Invoked in a STA upon dis-association
  // or in an AP upon reboot
  void Reset (void);
  // Invoked in a STA upon association to store
  // the set of rates which belong to the
  // BSSBasicRateSet of the associated AP
  // and which are supported locally.
  // Invoked in an AP to configure the BSSBasicRateSet
  void AddBasicMode (WifiMode mode);

  WifiMode GetDefaultMode (void) const;
  uint32_t GetNBasicModes (void) const;
  WifiMode GetBasicMode (uint32_t i) const;

  WifiMode GetNonUnicastMode (void) const;


  void Reset (Mac48Address address);
  void AddSupportedMode (Mac48Address address, WifiMode mode);

  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, uint32_t fullPacketSize);
  WifiMode GetDataMode (Mac48Address address, const WifiMacHeader *header,
                        Ptr<const Packet> packet, uint32_t fullPacketSize);
  WifiMode GetRtsMode (Mac48Address address, const WifiMacHeader *header,
                       Ptr<const Packet> packet);
  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 ReportRxOk (Mac48Address address, const WifiMacHeader *header,
                   double rxSnr, WifiMode txMode);

  bool NeedRts (Mac48Address address, const WifiMacHeader *header,
                Ptr<const Packet> packet);
  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);

  WifiMode GetCtsMode (Mac48Address address, WifiMode rtsMode);
  WifiMode GetAckMode (Mac48Address address, WifiMode dataMode);

  WifiRemoteStationInfo GetInfo (Mac48Address address);
protected:
  virtual void DoDispose (void);
  // for convenience
  WifiMode GetSupported (const WifiRemoteStation *station, uint32_t i) const;
  uint32_t GetNSupported (const WifiRemoteStation *station) 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 WifiMode DoGetDataMode (WifiRemoteStation *station,
                                  uint32_t size) = 0;
  virtual WifiMode DoGetRtsMode (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) = 0;
  virtual void DoReportFinalRtsFailed (WifiRemoteStation *station) = 0;
  virtual void DoReportFinalDataFailed (WifiRemoteStation *station) = 0;
  virtual void DoReportRxOk (WifiRemoteStation *station,
                             double rxSnr, WifiMode txMode) = 0;

  WifiRemoteStationState* LookupState (Mac48Address address) const;
  WifiRemoteStation* Lookup (Mac48Address address, uint8_t tid) const;
  WifiRemoteStation* Lookup (Mac48Address address, const WifiMacHeader *header) 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;

  StationStates m_states;
  Stations m_stations;
  Ptr<WifiPhy> m_wifiPhy;
  WifiMode m_defaultTxMode;

  WifiModeList m_bssBasicRateSet;

  bool m_isLowLatency;
  uint32_t m_maxSsrc;
  uint32_t m_maxSlrc;
  uint32_t m_rtsCtsThreshold;
  uint32_t m_fragmentationThreshold;
  WifiMode m_nonUnicastMode;
  double m_avgSlrcCoefficient;
  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;

  Mac48Address m_address;
  WifiRemoteStationInfo m_info;
};

struct WifiRemoteStation
{
  WifiRemoteStationState *m_state;
  uint32_t m_ssrc;
  uint32_t m_slrc;
  uint8_t m_tid;
};


} // namespace ns3

#endif /* WIFI_REMOTE_STATION_MANAGER_H */