sys/netproto/802_11/wlan/ieee80211_amrr.c

   1 /*      $OpenBSD: ieee80211_amrr.c,v 1.1 2006/06/17 19:07:19 damien Exp $       */
   2
   3 /*-
   4  * Copyright (c) 2010 Rui Paulo <rpaulo@FreeBSD.org>
   5  * Copyright (c) 2006
   6  *      Damien Bergamini <damien.bergamini@free.fr>
   7  *
   8  * Permission to use, copy, modify, and distribute this software for any
   9  * purpose with or without fee is hereby granted, provided that the above
  10  * copyright notice and this permission notice appear in all copies.
  11  *
  12  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  13  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  14  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  15  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  16  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  17  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  18  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  19  *
  20  * $FreeBSD: head/sys/net80211/ieee80211_amrr.c 206358 2010-04-07 15:29:13Z rpaulo $
  21  * $DragonFly$
  22  */
  23
  24
  25 /*-
  26  * Naive implementation of the Adaptive Multi Rate Retry algorithm:
  27  *
  28  * "IEEE 802.11 Rate Adaptation: A Practical Approach"
  29  *  Mathieu Lacage, Hossein Manshaei, Thierry Turletti
  30  *  INRIA Sophia - Projet Planete
  31  *  http://www-sop.inria.fr/rapports/sophia/RR-5208.html
  32  */
  33 #include "opt_wlan.h"
  34
  35 #include <sys/param.h>
  36 #include <sys/kernel.h>
  37 #include <sys/module.h>
  38 #include <sys/socket.h>
  39 #include <sys/sysctl.h>
  40
  41 #include <net/if.h>
  42 #include <net/if_media.h>
  43
  44 #ifdef INET
  45 #include <netinet/in.h>
  46 #include <netinet/if_ether.h>
  47 #endif
  48
  49 #include <netproto/802_11/ieee80211_var.h>
  50 #include <netproto/802_11/ieee80211_amrr.h>
  51 #include <netproto/802_11/ieee80211_ratectl.h>
  52
  53 #define is_success(amn) \
  54         ((amn)->amn_retrycnt < (amn)->amn_txcnt / 10)
  55 #define is_failure(amn) \
  56         ((amn)->amn_retrycnt > (amn)->amn_txcnt / 3)
  57 #define is_enough(amn)          \
  58         ((amn)->amn_txcnt > 10)
  59
  60 static void     amrr_setinterval(const struct ieee80211vap *, int);
  61 static void     amrr_init(struct ieee80211vap *);
  62 static void     amrr_deinit(struct ieee80211vap *);
  63 static void     amrr_node_init(struct ieee80211_node *);
  64 static void     amrr_node_deinit(struct ieee80211_node *);
  65 static int      amrr_update(struct ieee80211_amrr *,
  66                         struct ieee80211_amrr_node *, struct ieee80211_node *);
  67 static int      amrr_rate(struct ieee80211_node *, void *, uint32_t);
  68 static void     amrr_tx_complete(const struct ieee80211vap *,
  69                         const struct ieee80211_node *, int,
  70                         void *, void *);
  71 static void     amrr_tx_update(const struct ieee80211vap *vap,
  72                         const struct ieee80211_node *, void *, void *, void *);
  73 static void     amrr_sysctlattach(struct ieee80211vap *,
  74                         struct sysctl_ctx_list *, struct sysctl_oid *);
  75
  76 /* number of references from net80211 layer */
  77 static  int nrefs = 0;
  78
  79 static const struct ieee80211_ratectl amrr = {
  80         .ir_name        = "amrr",
  81         .ir_attach      = NULL,
  82         .ir_detach      = NULL,
  83         .ir_init        = amrr_init,
  84         .ir_deinit      = amrr_deinit,
  85         .ir_node_init   = amrr_node_init,
  86         .ir_node_deinit = amrr_node_deinit,
  87         .ir_rate        = amrr_rate,
  88         .ir_tx_complete = amrr_tx_complete,
  89         .ir_tx_update   = amrr_tx_update,
  90         .ir_setinterval = amrr_setinterval,
  91 };
  92 IEEE80211_RATECTL_MODULE(amrr, 1);
  93 IEEE80211_RATECTL_ALG(amrr, IEEE80211_RATECTL_AMRR, amrr);
  94
  95 static void
  96 amrr_setinterval(const struct ieee80211vap *vap, int msecs)
  97 {
  98         struct ieee80211_amrr *amrr = vap->iv_rs;
  99         int t;
 100
 101         if (msecs < 100)
 102                 msecs = 100;
 103         t = msecs_to_ticks(msecs);
 104         amrr->amrr_interval = (t < 1) ? 1 : t;
 105 }
 106
 107 static void
 108 amrr_init(struct ieee80211vap *vap)
 109 {
 110         struct ieee80211_amrr *amrr;
 111
 112         KASSERT(vap->iv_rs == NULL, ("%s called multiple times", __func__));
 113
 114         vap->iv_rs = kmalloc(sizeof(struct ieee80211_amrr), M_80211_RATECTL,
 115             M_WAITOK|M_ZERO);
 116         amrr = vap->iv_rs;
 117         amrr->amrr_min_success_threshold = IEEE80211_AMRR_MIN_SUCCESS_THRESHOLD;
 118         amrr->amrr_max_success_threshold = IEEE80211_AMRR_MAX_SUCCESS_THRESHOLD;
 119         amrr_setinterval(vap, 500 /* ms */);
 120         amrr_sysctlattach(vap, vap->iv_sysctl, vap->iv_oid);
 121 }
 122
 123 static void
 124 amrr_deinit(struct ieee80211vap *vap)
 125 {
 126         kfree(vap->iv_rs, M_80211_RATECTL);
 127 }
 128
 129 static void
 130 amrr_node_init(struct ieee80211_node *ni)
 131 {
 132         const struct ieee80211_rateset *rs = &ni->ni_rates;
 133         struct ieee80211vap *vap = ni->ni_vap;
 134         struct ieee80211_amrr *amrr = vap->iv_rs;
 135         struct ieee80211_amrr_node *amn;
 136
 137         KASSERT(ni->ni_rctls == NULL, ("%s: ni_rctls already initialized",
 138             __func__));
 139
 140         ni->ni_rctls = kmalloc(sizeof(struct ieee80211_amrr_node),
 141             M_80211_RATECTL, M_WAITOK|M_ZERO);
 142         amn = ni->ni_rctls;
 143         amn->amn_amrr = amrr;
 144         amn->amn_success = 0;
 145         amn->amn_recovery = 0;
 146         amn->amn_txcnt = amn->amn_retrycnt = 0;
 147         amn->amn_success_threshold = amrr->amrr_min_success_threshold;
 148
 149         /* pick initial rate */
 150         for (amn->amn_rix = rs->rs_nrates - 1;
 151              amn->amn_rix > 0 && (rs->rs_rates[amn->amn_rix] & IEEE80211_RATE_VAL) > 72;
 152              amn->amn_rix--)
 153                 ;
 154         ni->ni_txrate = rs->rs_rates[amn->amn_rix] & IEEE80211_RATE_VAL;
 155         amn->amn_ticks = ticks;
 156
 157         IEEE80211_NOTE(ni->ni_vap, IEEE80211_MSG_RATECTL, ni,
 158             "AMRR initial rate %d", ni->ni_txrate);
 159 }
 160
 161 static void
 162 amrr_node_deinit(struct ieee80211_node *ni)
 163 {
 164         kfree(ni->ni_rctls, M_80211_RATECTL);
 165 }
 166
 167 static int
 168 amrr_update(struct ieee80211_amrr *amrr, struct ieee80211_amrr_node *amn,
 169     struct ieee80211_node *ni)
 170 {
 171         int rix = amn->amn_rix;
 172
 173         KASSERT(is_enough(amn), ("txcnt %d", amn->amn_txcnt));
 174
 175         if (is_success(amn)) {
 176                 amn->amn_success++;
 177                 if (amn->amn_success >= amn->amn_success_threshold &&
 178                     rix + 1 < ni->ni_rates.rs_nrates) {
 179                         amn->amn_recovery = 1;
 180                         amn->amn_success = 0;
 181                         rix++;
 182                         IEEE80211_NOTE(ni->ni_vap, IEEE80211_MSG_RATECTL, ni,
 183                             "AMRR increasing rate %d (txcnt=%d retrycnt=%d)",
 184                             ni->ni_rates.rs_rates[rix] & IEEE80211_RATE_VAL,
 185                             amn->amn_txcnt, amn->amn_retrycnt);
 186                 } else {
 187                         amn->amn_recovery = 0;
 188                 }
 189         } else if (is_failure(amn)) {
 190                 amn->amn_success = 0;
 191                 if (rix > 0) {
 192                         if (amn->amn_recovery) {
 193                                 amn->amn_success_threshold *= 2;
 194                                 if (amn->amn_success_threshold >
 195                                     amrr->amrr_max_success_threshold)
 196                                         amn->amn_success_threshold =
 197                                             amrr->amrr_max_success_threshold;
 198                         } else {
 199                                 amn->amn_success_threshold =
 200                                     amrr->amrr_min_success_threshold;
 201                         }
 202                         rix--;
 203                         IEEE80211_NOTE(ni->ni_vap, IEEE80211_MSG_RATECTL, ni,
 204                             "AMRR decreasing rate %d (txcnt=%d retrycnt=%d)",
 205                             ni->ni_rates.rs_rates[rix] & IEEE80211_RATE_VAL,
 206                             amn->amn_txcnt, amn->amn_retrycnt);
 207                 }
 208                 amn->amn_recovery = 0;
 209         }
 210
 211         /* reset counters */
 212         amn->amn_txcnt = 0;
 213         amn->amn_retrycnt = 0;
 214
 215         return rix;
 216 }
 217
 218 /*
 219  * Return the rate index to use in sending a data frame.
 220  * Update our internal state if it's been long enough.
 221  * If the rate changes we also update ni_txrate to match.
 222  */
 223 static int
 224 amrr_rate(struct ieee80211_node *ni, void *arg __unused, uint32_t iarg __unused)
 225 {
 226         struct ieee80211_amrr_node *amn = ni->ni_rctls;
 227         struct ieee80211_amrr *amrr = amn->amn_amrr;
 228         int rix;
 229
 230         if (is_enough(amn) && (ticks - amn->amn_ticks) > amrr->amrr_interval) {
 231                 rix = amrr_update(amrr, amn, ni);
 232                 if (rix != amn->amn_rix) {
 233                         /* update public rate */
 234                         ni->ni_txrate =
 235                             ni->ni_rates.rs_rates[rix] & IEEE80211_RATE_VAL;
 236                         amn->amn_rix = rix;
 237                 }
 238                 amn->amn_ticks = ticks;
 239         } else
 240                 rix = amn->amn_rix;
 241         return rix;
 242 }
 243
 244 /*
 245  * Update statistics with tx complete status.  Ok is non-zero
 246  * if the packet is known to be ACK'd.  Retries has the number
 247  * retransmissions (i.e. xmit attempts - 1).
 248  */
 249 static void
 250 amrr_tx_complete(const struct ieee80211vap *vap,
 251     const struct ieee80211_node *ni, int ok,
 252     void *arg1, void *arg2 __unused)
 253 {
 254         struct ieee80211_amrr_node *amn = ni->ni_rctls;
 255         int retries = *(int *)arg1;
 256
 257         amn->amn_txcnt++;
 258         if (ok)
 259                 amn->amn_success++;
 260         amn->amn_retrycnt += retries;
 261 }
 262
 263 /*
 264  * Set tx count/retry statistics explicitly.  Intended for
 265  * drivers that poll the device for statistics maintained
 266  * in the device.
 267  */
 268 static void
 269 amrr_tx_update(const struct ieee80211vap *vap, const struct ieee80211_node *ni,
 270     void *arg1, void *arg2, void *arg3)
 271 {
 272         struct ieee80211_amrr_node *amn = ni->ni_rctls;
 273         int txcnt = *(int *)arg1, success = *(int *)arg2, retrycnt = *(int *)arg3;
 274
 275         amn->amn_txcnt = txcnt;
 276         amn->amn_success = success;
 277         amn->amn_retrycnt = retrycnt;
 278 }
 279
 280 static int
 281 amrr_sysctl_interval(SYSCTL_HANDLER_ARGS)
 282 {
 283         struct ieee80211vap *vap = arg1;
 284         struct ieee80211_amrr *amrr = vap->iv_rs;
 285         int msecs = ticks_to_msecs(amrr->amrr_interval);
 286         int error;
 287
 288         error = sysctl_handle_int(oidp, &msecs, 0, req);
 289         if (error || !req->newptr)
 290                 return error;
 291         amrr_setinterval(vap, msecs);
 292         return 0;
 293 }
 294
 295 static void
 296 amrr_sysctlattach(struct ieee80211vap *vap,
 297     struct sysctl_ctx_list *ctx, struct sysctl_oid *tree)
 298 {
 299         struct ieee80211_amrr *amrr = vap->iv_rs;
 300
 301         SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
 302             "amrr_rate_interval", CTLTYPE_INT | CTLFLAG_RW, vap,
 303             0, amrr_sysctl_interval, "I", "amrr operation interval (ms)");
 304         /* XXX bounds check values */
 305         SYSCTL_ADD_INT(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
 306             "amrr_max_sucess_threshold", CTLFLAG_RW,
 307             &amrr->amrr_max_success_threshold, 0, "");
 308         SYSCTL_ADD_INT(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
 309             "amrr_min_sucess_threshold", CTLFLAG_RW,
 310             &amrr->amrr_min_success_threshold, 0, "");
 311 }