src/devices/wifi/aarfcd-wifi-manager.h
author Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
Fri, 17 Apr 2009 09:56:04 +0200
changeset 4339 dd889b47f446
parent 4338 5327282789fc
child 4345 528d4150d2ac
permissions -rw-r--r--
add reference to paper
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
4334
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
     1
/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
     2
/*
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
     3
 * Copyright (c) 2005,2006 INRIA
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
     4
 *
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
     5
 * This program is free software; you can redistribute it and/or modify
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
     6
 * it under the terms of the GNU General Public License version 2 as 
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
     7
 * published by the Free Software Foundation;
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
     8
 *
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
     9
 * This program is distributed in the hope that it will be useful,
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    12
 * GNU General Public License for more details.
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    13
 *
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    14
 * You should have received a copy of the GNU General Public License
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    15
 * along with this program; if not, write to the Free Software
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    16
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    17
 *
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    18
 * Author: Federico Maguolo <maguolof@dei.unipd.it>
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    19
 */
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    20
#ifndef AARFCD_WIFI_MANAGER_H
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    21
#define AARFCD_WIFI_MANAGER_H
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    22
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    23
#include "wifi-remote-station-manager.h"
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    24
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    25
namespace ns3 {
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    26
4339
dd889b47f446 add reference to paper
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 4338
diff changeset
    27
/**
dd889b47f446 add reference to paper
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 4338
diff changeset
    28
 * \brief an implementation of the AARF-CD algorithm
dd889b47f446 add reference to paper
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 4338
diff changeset
    29
 *
dd889b47f446 add reference to paper
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 4338
diff changeset
    30
 * This algorithm was first described in "Efficient Collision Detection for Auto Rate Fallback Algorithm".
dd889b47f446 add reference to paper
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 4338
diff changeset
    31
 * The implementation available here was done by Federico Maguolo for a very early development
dd889b47f446 add reference to paper
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 4338
diff changeset
    32
 * version of ns-3. Federico died before merging this work in ns-3 itself so his code was ported
dd889b47f446 add reference to paper
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 4338
diff changeset
    33
 * to ns-3 later without his supervision.
dd889b47f446 add reference to paper
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 4338
diff changeset
    34
 */
4334
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    35
class AarfcdWifiManager : public WifiRemoteStationManager 
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    36
{
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    37
public:
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    38
  static TypeId GetTypeId (void);
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    39
  AarfcdWifiManager ();
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    40
  virtual ~AarfcdWifiManager ();
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    41
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    42
private:
4337
a74d21ce3298 use manager variables instead of per-station variables
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 4334
diff changeset
    43
  friend class AarfcdWifiRemoteStation;
4334
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    44
  virtual WifiRemoteStation *CreateStation (void);
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    45
  uint32_t m_minTimerThreshold;
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    46
  uint32_t m_minSuccessThreshold;
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    47
  double m_successK;
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    48
  uint32_t m_maxSuccessThreshold;
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    49
  double m_timerK;
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    50
  uint32_t m_minRtsWnd;
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    51
  uint32_t m_maxRtsWnd;
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    52
  bool m_rtsFailsAsDataFails;
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    53
  bool m_turnOffRtsAfterRateDecrease;
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    54
  bool m_turnOnRtsAfterRateIncrease;
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    55
};
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    56
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    57
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    58
class AarfcdWifiRemoteStation : public WifiRemoteStation
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    59
{
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    60
public:
4338
5327282789fc cleanup a bit
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 4337
diff changeset
    61
  AarfcdWifiRemoteStation (Ptr<AarfcdWifiManager> manager);
4334
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    62
  virtual ~AarfcdWifiRemoteStation ();
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    63
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    64
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    65
private:
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    66
  virtual void DoReportRxOk (double rxSnr, WifiMode txMode);
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    67
  virtual void DoReportRtsFailed (void);
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    68
  virtual void DoReportDataFailed (void);
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    69
  virtual void DoReportRtsOk (double ctsSnr, WifiMode ctsMode, double rtsSnr);
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    70
  virtual void DoReportDataOk (double ackSnr, WifiMode ackMode, double dataSnr);
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    71
  virtual void DoReportFinalRtsFailed (void);
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    72
  virtual void DoReportFinalDataFailed (void);
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    73
  virtual bool DoNeedRts (Ptr<const Packet> packet);
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    74
  virtual Ptr<WifiRemoteStationManager> GetManager (void) const;
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    75
  virtual WifiMode DoGetDataMode (uint32_t size);
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    76
  virtual WifiMode DoGetRtsMode (void);
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    77
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    78
  void ReportRecoveryFailure (void);
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    79
  void ReportFailure (void);
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    80
  uint32_t GetMaxRate (void);
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    81
  uint32_t GetMinRate (void);
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    82
  void CheckRts (void);
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    83
  void IncreaseRtsWnd (void);
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    84
  void ResetRtsWnd (void);
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    85
  void TurnOffRts (void);
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    86
  void TurnOnRts (void);
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    87
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    88
  bool NeedRecoveryFallback (void);
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    89
  bool NeedNormalFallback (void);
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    90
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    91
  uint32_t m_timer;
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    92
  uint32_t m_success;
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    93
  uint32_t m_failed;
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    94
  bool m_recovery;
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    95
  bool m_justModifyRate;
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    96
  uint32_t m_retry;
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    97
  
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    98
  uint32_t m_successThreshold;
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
    99
  uint32_t m_timerTimeout;
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
   100
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
   101
  uint32_t m_rate;
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
   102
  bool m_rtsOn;
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
   103
  uint32_t m_rtsWnd;
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
   104
  uint32_t m_rtsCounter;
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
   105
  bool m_haveASuccess;
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
   106
  
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
   107
  Ptr<AarfcdWifiManager> m_manager;
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
   108
};
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
   109
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
   110
} // namespace ns3
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
   111
12b3fcf84fc5 bug 536: aarf-cd rate control
Federico Maguolo <maguolof@dei.unipd.it>
parents:
diff changeset
   112
#endif /* MAARF_MAC_STATIONS_H */