src/devices/wifi/onoe-wifi-manager.h
author Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
Mon, 03 Mar 2008 04:03:39 +0100
changeset 2544 2e6e1a6e0d94
parent 2272 src/devices/wifi/onoe-mac-stations.h@ae2bbdbfc161
child 2784 49006cbbfac7
permissions -rw-r--r--
port last rate control algorithms
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2271
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     1
/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     2
/*
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     3
 * Copyright (c) 2003,2007 INRIA
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     4
 *
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     5
 * This program is free software; you can redistribute it and/or modify
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     6
 * it under the terms of the GNU General Public License version 2 as 
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     7
 * published by the Free Software Foundation;
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     8
 *
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     9
 * This program is distributed in the hope that it will be useful,
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    12
 * GNU General Public License for more details.
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    13
 *
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    14
 * You should have received a copy of the GNU General Public License
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    15
 * along with this program; if not, write to the Free Software
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    16
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    17
 *
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    18
 * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    19
 */
2544
2e6e1a6e0d94 port last rate control algorithms
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2272
diff changeset
    20
#ifndef ONOE_WIFI_MANAGER_H
2e6e1a6e0d94 port last rate control algorithms
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2272
diff changeset
    21
#define ONOE_WIFI_MANAGER_H
2271
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    22
2544
2e6e1a6e0d94 port last rate control algorithms
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2272
diff changeset
    23
#include "wifi-remote-station-manager.h"
2271
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    24
#include "ns3/nstime.h"
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    25
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    26
namespace ns3 {
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    27
2544
2e6e1a6e0d94 port last rate control algorithms
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2272
diff changeset
    28
class OnoeWifiManager : public WifiRemoteStationManager
2271
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    29
{
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    30
public:
2544
2e6e1a6e0d94 port last rate control algorithms
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2272
diff changeset
    31
  static TypeId GetTypeId (void);
2e6e1a6e0d94 port last rate control algorithms
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2272
diff changeset
    32
2e6e1a6e0d94 port last rate control algorithms
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2272
diff changeset
    33
  OnoeWifiManager ();
2271
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    34
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    35
private:
2544
2e6e1a6e0d94 port last rate control algorithms
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2272
diff changeset
    36
  friend class OnoeWifiRemoteStation;
2e6e1a6e0d94 port last rate control algorithms
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2272
diff changeset
    37
  virtual WifiRemoteStation *CreateStation (void);
2271
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    38
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    39
  Time m_updatePeriod;
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    40
  uint32_t m_addCreditThreshold;
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    41
  uint32_t m_raiseThreshold;
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    42
};
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    43
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    44
/**
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    45
 * \brief an implementation of rate control algorithm developed 
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    46
 *        by Atsushi Onoe
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    47
 *
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    48
 * This algorithm is well known because it has been used as the default
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    49
 * rate control algorithm for the madwifi driver. I am not aware of
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    50
 * any publication or reference about this algorithm beyond the madwifi
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    51
 * source code.
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    52
 */
2544
2e6e1a6e0d94 port last rate control algorithms
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2272
diff changeset
    53
class OnoeWifiRemoteStation : public WifiRemoteStation
2271
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    54
{
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    55
public:
2544
2e6e1a6e0d94 port last rate control algorithms
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2272
diff changeset
    56
  OnoeWifiRemoteStation (Ptr<OnoeWifiManager> stations);
2271
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    57
2544
2e6e1a6e0d94 port last rate control algorithms
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2272
diff changeset
    58
  virtual ~OnoeWifiRemoteStation ();
2271
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    59
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    60
  virtual void ReportRxOk (double rxSnr, WifiMode txMode);
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    61
  virtual void ReportRtsFailed (void);
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    62
  virtual void ReportDataFailed (void);
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    63
  virtual void ReportRtsOk (double ctsSnr, WifiMode ctsMode, double rtsSnr);
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    64
  virtual void ReportDataOk (double ackSnr, WifiMode ackMode, double dataSnr);
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    65
  virtual void ReportFinalRtsFailed (void);
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    66
  virtual void ReportFinalDataFailed (void);
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    67
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    68
private:
2544
2e6e1a6e0d94 port last rate control algorithms
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2272
diff changeset
    69
  virtual Ptr<WifiRemoteStationManager> GetManager (void) const;
2271
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    70
  virtual WifiMode DoGetDataMode (uint32_t size);
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    71
  virtual WifiMode DoGetRtsMode (void);
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    72
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    73
  void UpdateRetry (void);
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    74
  void UpdateMode (void);
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    75
2544
2e6e1a6e0d94 port last rate control algorithms
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2272
diff changeset
    76
  Ptr<OnoeWifiManager> m_stations;
2272
ae2bbdbfc161 the meat of the onoe rate control algorithm.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2271
diff changeset
    77
  Time m_nextModeUpdate;
2271
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    78
  uint32_t m_shortRetry;
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    79
  uint32_t m_longRetry;
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    80
  uint32_t m_tx_ok;
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    81
  uint32_t m_tx_err;
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    82
  uint32_t m_tx_retr;
2272
ae2bbdbfc161 the meat of the onoe rate control algorithm.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2271
diff changeset
    83
  uint32_t m_tx_upper;
ae2bbdbfc161 the meat of the onoe rate control algorithm.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2271
diff changeset
    84
  uint32_t m_txrate;
2271
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    85
};
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    86
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    87
} // namespace ns3
85724b1cbb1a Onoe rate control
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    88
2544
2e6e1a6e0d94 port last rate control algorithms
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2272
diff changeset
    89
#endif /* ONOE_WIFI_MANAGER_H */