ieee80211_amrr.c revision 217322
163670Snsayer/* $OpenBSD: ieee80211_amrr.c,v 1.1 2006/06/17 19:07:19 damien Exp $ */ 263670Snsayer 363670Snsayer/*- 463670Snsayer * Copyright (c) 2010 Rui Paulo <rpaulo@FreeBSD.org> 563670Snsayer * Copyright (c) 2006 663670Snsayer * Damien Bergamini <damien.bergamini@free.fr> 763670Snsayer * 863670Snsayer * Permission to use, copy, modify, and distribute this software for any 963670Snsayer * purpose with or without fee is hereby granted, provided that the above 1063670Snsayer * copyright notice and this permission notice appear in all copies. 1163670Snsayer * 1263670Snsayer * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 1363670Snsayer * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 1463670Snsayer * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 1563670Snsayer * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 1663670Snsayer * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 1763670Snsayer * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 1863670Snsayer * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 1963670Snsayer */ 2063670Snsayer 2163670Snsayer#include <sys/cdefs.h> 2263670Snsayer__FBSDID("$FreeBSD: head/sys/net80211/ieee80211_amrr.c 217322 2011-01-12 19:53:50Z mdf $"); 2363670Snsayer 2463670Snsayer/*- 2563670Snsayer * Naive implementation of the Adaptive Multi Rate Retry algorithm: 2663670Snsayer * 2763670Snsayer * "IEEE 802.11 Rate Adaptation: A Practical Approach" 2863670Snsayer * Mathieu Lacage, Hossein Manshaei, Thierry Turletti 2963670Snsayer * INRIA Sophia - Projet Planete 3063670Snsayer * http://www-sop.inria.fr/rapports/sophia/RR-5208.html 3163670Snsayer */ 3263670Snsayer#include "opt_wlan.h" 3363670Snsayer 3463670Snsayer#include <sys/param.h> 3563803Snsayer#include <sys/kernel.h> 3663670Snsayer#include <sys/module.h> 3763670Snsayer#include <sys/socket.h> 3863670Snsayer#include <sys/sysctl.h> 3963670Snsayer 4063670Snsayer#include <net/if.h> 4163670Snsayer#include <net/if_media.h> 4263670Snsayer 4363670Snsayer#ifdef INET 4463670Snsayer#include <netinet/in.h> 4563670Snsayer#include <netinet/if_ether.h> 4663670Snsayer#endif 4763670Snsayer 4863670Snsayer#include <net80211/ieee80211_var.h> 4963670Snsayer#include <net80211/ieee80211_amrr.h> 5063670Snsayer#include <net80211/ieee80211_ratectl.h> 5163670Snsayer 5263670Snsayer#define is_success(amn) \ 5363670Snsayer ((amn)->amn_retrycnt < (amn)->amn_txcnt / 10) 5463670Snsayer#define is_failure(amn) \ 5563670Snsayer ((amn)->amn_retrycnt > (amn)->amn_txcnt / 3) 5663670Snsayer#define is_enough(amn) \ 5783043Sbrooks ((amn)->amn_txcnt > 10) 5863670Snsayer 5963670Snsayerstatic void amrr_setinterval(const struct ieee80211vap *, int); 6063670Snsayerstatic void amrr_init(struct ieee80211vap *); 6163670Snsayerstatic void amrr_deinit(struct ieee80211vap *); 6263670Snsayerstatic void amrr_node_init(struct ieee80211_node *); 6363670Snsayerstatic void amrr_node_deinit(struct ieee80211_node *); 6463670Snsayerstatic int amrr_update(struct ieee80211_amrr *, 6563670Snsayer struct ieee80211_amrr_node *, struct ieee80211_node *); 6663670Snsayerstatic int amrr_rate(struct ieee80211_node *, void *, uint32_t); 6763670Snsayerstatic void amrr_tx_complete(const struct ieee80211vap *, 6863670Snsayer const struct ieee80211_node *, int, 6963670Snsayer void *, void *); 7063670Snsayerstatic void amrr_tx_update(const struct ieee80211vap *vap, 7163670Snsayer const struct ieee80211_node *, void *, void *, void *); 7263670Snsayerstatic void amrr_sysctlattach(struct ieee80211vap *, 7363670Snsayer struct sysctl_ctx_list *, struct sysctl_oid *); 7463670Snsayer 7563670Snsayer/* number of references from net80211 layer */ 7683043Sbrooksstatic int nrefs = 0; 77126077Sphk 7863670Snsayerstatic const struct ieee80211_ratectl amrr = { 7963670Snsayer .ir_name = "amrr", 80111742Sdes .ir_attach = NULL, 8163670Snsayer .ir_detach = NULL, 8263670Snsayer .ir_init = amrr_init, 8393084Sbde .ir_deinit = amrr_deinit, 8493084Sbde .ir_node_init = amrr_node_init, 8563670Snsayer .ir_node_deinit = amrr_node_deinit, 8663670Snsayer .ir_rate = amrr_rate, 8793084Sbde .ir_tx_complete = amrr_tx_complete, 8893084Sbde .ir_tx_update = amrr_tx_update, 8993084Sbde .ir_setinterval = amrr_setinterval, 9063670Snsayer}; 9163670SnsayerIEEE80211_RATECTL_MODULE(amrr, 1); 9263670SnsayerIEEE80211_RATECTL_ALG(amrr, IEEE80211_RATECTL_AMRR, amrr); 9363670Snsayer 9463670Snsayerstatic void 9563670Snsayeramrr_setinterval(const struct ieee80211vap *vap, int msecs) 9663670Snsayer{ 9763670Snsayer struct ieee80211_amrr *amrr = vap->iv_rs; 9863670Snsayer int t; 9963670Snsayer 100126080Sphk if (msecs < 100) 101126188Sbde msecs = 100; 102111815Sphk t = msecs_to_ticks(msecs); 103111815Sphk amrr->amrr_interval = (t < 1) ? 1 : t; 104111815Sphk} 105111815Sphk 106111815Sphkstatic void 107111815Sphkamrr_init(struct ieee80211vap *vap) 108111815Sphk{ 10963670Snsayer struct ieee80211_amrr *amrr; 11063670Snsayer 111127003Srwatson KASSERT(vap->iv_rs == NULL, ("%s called multiple times", __func__)); 112127003Srwatson 113127003Srwatson amrr = vap->iv_rs = malloc(sizeof(struct ieee80211_amrr), 114127003Srwatson M_80211_RATECTL, M_NOWAIT|M_ZERO); 115127003Srwatson if (amrr == NULL) { 116127003Srwatson if_printf(vap->iv_ifp, "couldn't alloc ratectl structure\n"); 11783043Sbrooks return; 11883043Sbrooks } 119126077Sphk amrr->amrr_min_success_threshold = IEEE80211_AMRR_MIN_SUCCESS_THRESHOLD; 12063670Snsayer amrr->amrr_max_success_threshold = IEEE80211_AMRR_MAX_SUCCESS_THRESHOLD; 12163670Snsayer amrr_setinterval(vap, 500 /* ms */); 12263670Snsayer amrr_sysctlattach(vap, vap->iv_sysctl, vap->iv_oid); 12363670Snsayer} 12463670Snsayer 12563670Snsayerstatic void 12663670Snsayeramrr_deinit(struct ieee80211vap *vap) 12763670Snsayer{ 12863670Snsayer free(vap->iv_rs, M_80211_RATECTL); 12963670Snsayer} 13063670Snsayer 13163670Snsayerstatic void 13263670Snsayeramrr_node_init(struct ieee80211_node *ni) 13363670Snsayer{ 13463670Snsayer const struct ieee80211_rateset *rs = &ni->ni_rates; 13563670Snsayer struct ieee80211vap *vap = ni->ni_vap; 13663670Snsayer struct ieee80211_amrr *amrr = vap->iv_rs; 13783043Sbrooks struct ieee80211_amrr_node *amn; 13883043Sbrooks 13983043Sbrooks if (ni->ni_rctls == NULL) { 140126077Sphk ni->ni_rctls = amn = malloc(sizeof(struct ieee80211_amrr_node), 14163670Snsayer M_80211_RATECTL, M_NOWAIT|M_ZERO); 14263670Snsayer if (amn == NULL) { 14363670Snsayer if_printf(vap->iv_ifp, "couldn't alloc per-node ratectl " 14463670Snsayer "structure\n"); 14583043Sbrooks return; 14683043Sbrooks } 147127003Srwatson } else 14883043Sbrooks amn = ni->ni_rctls; 14983043Sbrooks amn->amn_amrr = amrr; 150126845Sphk amn->amn_success = 0; 15171602Sphk amn->amn_recovery = 0; 152127003Srwatson amn->amn_txcnt = amn->amn_retrycnt = 0; 153127170Srwatson amn->amn_success_threshold = amrr->amrr_min_success_threshold; 154127003Srwatson 155126077Sphk /* pick initial rate */ 156127003Srwatson for (amn->amn_rix = rs->rs_nrates - 1; 15783043Sbrooks amn->amn_rix > 0 && (rs->rs_rates[amn->amn_rix] & IEEE80211_RATE_VAL) > 72; 15863670Snsayer amn->amn_rix--) 15983043Sbrooks ; 160127003Srwatson ni->ni_txrate = rs->rs_rates[amn->amn_rix] & IEEE80211_RATE_VAL; 161127003Srwatson amn->amn_ticks = ticks; 162127003Srwatson 163127003Srwatson IEEE80211_NOTE(ni->ni_vap, IEEE80211_MSG_RATECTL, ni, 164127003Srwatson "AMRR initial rate %d", ni->ni_txrate); 165127003Srwatson} 166127003Srwatson 167127098Srwatsonstatic void 168127003Srwatsonamrr_node_deinit(struct ieee80211_node *ni) 169127098Srwatson{ 170127003Srwatson free(ni->ni_rctls, M_80211_RATECTL); 17183043Sbrooks} 172127003Srwatson 173127098Srwatsonstatic int 174127003Srwatsonamrr_update(struct ieee80211_amrr *amrr, struct ieee80211_amrr_node *amn, 175127003Srwatson struct ieee80211_node *ni) 17683043Sbrooks{ 17771602Sphk int rix = amn->amn_rix; 17863670Snsayer 179127003Srwatson KASSERT(is_enough(amn), ("txcnt %d", amn->amn_txcnt)); 18083043Sbrooks 18183043Sbrooks if (is_success(amn)) { 182127003Srwatson amn->amn_success++; 18383043Sbrooks if (amn->amn_success >= amn->amn_success_threshold && 18483043Sbrooks rix + 1 < ni->ni_rates.rs_nrates) { 18583043Sbrooks amn->amn_recovery = 1; 186121816Sbrooks amn->amn_success = 0; 18783043Sbrooks rix++; 188127098Srwatson IEEE80211_NOTE(ni->ni_vap, IEEE80211_MSG_RATECTL, ni, 189121816Sbrooks "AMRR increasing rate %d (txcnt=%d retrycnt=%d)", 190121816Sbrooks ni->ni_rates.rs_rates[rix] & IEEE80211_RATE_VAL, 19183043Sbrooks amn->amn_txcnt, amn->amn_retrycnt); 192126077Sphk } else { 19363670Snsayer amn->amn_recovery = 0; 194106939Ssam } 19563670Snsayer } else if (is_failure(amn)) { 19663670Snsayer amn->amn_success = 0; 197127098Srwatson if (rix > 0) { 19893752Sluigi if (amn->amn_recovery) { 199127003Srwatson amn->amn_success_threshold *= 2; 20083043Sbrooks if (amn->amn_success_threshold > 201127003Srwatson amrr->amrr_max_success_threshold) 202126077Sphk amn->amn_success_threshold = 20363670Snsayer amrr->amrr_max_success_threshold; 20483043Sbrooks } else { 20563670Snsayer amn->amn_success_threshold = 20663670Snsayer amrr->amrr_min_success_threshold; 20763670Snsayer } 20863670Snsayer rix--; 20963670Snsayer IEEE80211_NOTE(ni->ni_vap, IEEE80211_MSG_RATECTL, ni, 21063670Snsayer "AMRR decreasing rate %d (txcnt=%d retrycnt=%d)", 21163670Snsayer ni->ni_rates.rs_rates[rix] & IEEE80211_RATE_VAL, 21263670Snsayer amn->amn_txcnt, amn->amn_retrycnt); 21363670Snsayer } 21463670Snsayer amn->amn_recovery = 0; 21571602Sphk } 21671602Sphk 21771602Sphk /* reset counters */ 21871602Sphk amn->amn_txcnt = 0; 21971602Sphk amn->amn_retrycnt = 0; 22071602Sphk 22171602Sphk return rix; 22271602Sphk} 22371602Sphk 22471602Sphk/* 22571602Sphk * Return the rate index to use in sending a data frame. 226126077Sphk * Update our internal state if it's been long enough. 227126077Sphk * If the rate changes we also update ni_txrate to match. 22883043Sbrooks */ 22971602Sphkstatic int 23071602Sphkamrr_rate(struct ieee80211_node *ni, void *arg __unused, uint32_t iarg __unused) 23171602Sphk{ 23271602Sphk struct ieee80211_amrr_node *amn = ni->ni_rctls; 233126077Sphk struct ieee80211_amrr *amrr = amn->amn_amrr; 234126077Sphk int rix; 235126077Sphk 236126077Sphk if (is_enough(amn) && (ticks - amn->amn_ticks) > amrr->amrr_interval) { 237126077Sphk rix = amrr_update(amrr, amn, ni); 238126077Sphk if (rix != amn->amn_rix) { 239126077Sphk /* update public rate */ 240126077Sphk ni->ni_txrate = 241126077Sphk ni->ni_rates.rs_rates[rix] & IEEE80211_RATE_VAL; 242126077Sphk amn->amn_rix = rix; 243126077Sphk } 244126077Sphk amn->amn_ticks = ticks; 245126077Sphk } else 24683043Sbrooks rix = amn->amn_rix; 24771602Sphk return rix; 248126077Sphk} 249126077Sphk 250126077Sphk/* 251126796Sphk * Update statistics with tx complete status. Ok is non-zero 252126077Sphk * if the packet is known to be ACK'd. Retries has the number 253126077Sphk * retransmissions (i.e. xmit attempts - 1). 254126077Sphk */ 25571602Sphkstatic void 25671602Sphkamrr_tx_complete(const struct ieee80211vap *vap, 25771602Sphk const struct ieee80211_node *ni, int ok, 25871602Sphk void *arg1, void *arg2 __unused) 25971602Sphk{ 26063670Snsayer struct ieee80211_amrr_node *amn = ni->ni_rctls; 26163670Snsayer int retries = *(int *)arg1; 26263670Snsayer 26363670Snsayer amn->amn_txcnt++; 26463670Snsayer if (ok) 26563670Snsayer amn->amn_success++; 26663670Snsayer amn->amn_retrycnt += retries; 26763670Snsayer} 26863670Snsayer 26963670Snsayer/* 27063670Snsayer * Set tx count/retry statistics explicitly. Intended for 27163803Snsayer * drivers that poll the device for statistics maintained 27263670Snsayer * in the device. 27363670Snsayer */ 274126077Sphkstatic void 275126077Sphkamrr_tx_update(const struct ieee80211vap *vap, const struct ieee80211_node *ni, 27663670Snsayer void *arg1, void *arg2, void *arg3) 277111119Simp{ 278127098Srwatson struct ieee80211_amrr_node *amn = ni->ni_rctls; 279127003Srwatson int txcnt = *(int *)arg1, success = *(int *)arg2, retrycnt = *(int *)arg3; 28083043Sbrooks 281127003Srwatson amn->amn_txcnt = txcnt; 28263670Snsayer amn->amn_success = success; 283126796Sphk amn->amn_retrycnt = retrycnt; 28483043Sbrooks} 28563670Snsayer 286126796Sphkstatic int 28763670Snsayeramrr_sysctl_interval(SYSCTL_HANDLER_ARGS) 28863803Snsayer{ 28983043Sbrooks struct ieee80211vap *vap = arg1; 29063670Snsayer struct ieee80211_amrr *amrr = vap->iv_rs; 29163670Snsayer int msecs = ticks_to_msecs(amrr->amrr_interval); 292126796Sphk int error; 293126796Sphk 29483043Sbrooks error = sysctl_handle_int(oidp, &msecs, 0, req); 29583043Sbrooks if (error || !req->newptr) 29663670Snsayer return error; 29763670Snsayer amrr_setinterval(vap, msecs); 29863670Snsayer return 0; 29963670Snsayer} 30063670Snsayer 30163670Snsayerstatic void 302111742Sdesamrr_sysctlattach(struct ieee80211vap *vap, 30363670Snsayer struct sysctl_ctx_list *ctx, struct sysctl_oid *tree) 30463670Snsayer{ 305121816Sbrooks struct ieee80211_amrr *amrr = vap->iv_rs; 30663670Snsayer 30763670Snsayer SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(tree), OID_AUTO, 30863670Snsayer "amrr_rate_interval", CTLTYPE_INT | CTLFLAG_RW, vap, 30963670Snsayer 0, amrr_sysctl_interval, "I", "amrr operation interval (ms)"); 31063670Snsayer /* XXX bounds check values */ 31163670Snsayer SYSCTL_ADD_UINT(ctx, SYSCTL_CHILDREN(tree), OID_AUTO, 31263670Snsayer "amrr_max_sucess_threshold", CTLFLAG_RW, 31383043Sbrooks &amrr->amrr_max_success_threshold, 0, ""); 314126077Sphk SYSCTL_ADD_UINT(ctx, SYSCTL_CHILDREN(tree), OID_AUTO, 31583043Sbrooks "amrr_min_sucess_threshold", CTLFLAG_RW, 31663803Snsayer &amrr->amrr_min_success_threshold, 0, ""); 317106939Ssam} 31863803Snsayer