1178354Ssam/* $FreeBSD$ */ 2178354Ssam/* $NetBSD: ieee80211_rssadapt.c,v 1.9 2005/02/26 22:45:09 perry Exp $ */ 3178354Ssam/*- 4206358Srpaulo * Copyright (c) 2010 Rui Paulo <rpaulo@FreeBSD.org> 5178354Ssam * Copyright (c) 2003, 2004 David Young. All rights reserved. 6178354Ssam * 7178354Ssam * Redistribution and use in source and binary forms, with or 8178354Ssam * without modification, are permitted provided that the following 9178354Ssam * conditions are met: 10178354Ssam * 1. Redistributions of source code must retain the above copyright 11178354Ssam * notice, this list of conditions and the following disclaimer. 12178354Ssam * 2. Redistributions in binary form must reproduce the above 13178354Ssam * copyright notice, this list of conditions and the following 14178354Ssam * disclaimer in the documentation and/or other materials provided 15178354Ssam * with the distribution. 16178354Ssam * 3. The name of David Young may not be used to endorse or promote 17178354Ssam * products derived from this software without specific prior 18178354Ssam * written permission. 19178354Ssam * 20178354Ssam * THIS SOFTWARE IS PROVIDED BY David Young ``AS IS'' AND ANY 21178354Ssam * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 22178354Ssam * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A 23178354Ssam * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL David 24178354Ssam * Young BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 25178354Ssam * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 26178354Ssam * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 27178354Ssam * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 28178354Ssam * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 29178354Ssam * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30178354Ssam * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 31178354Ssam * OF SUCH DAMAGE. 32178354Ssam */ 33178354Ssam#include "opt_wlan.h" 34178354Ssam 35178354Ssam#include <sys/param.h> 36178354Ssam#include <sys/kernel.h> 37178354Ssam#include <sys/module.h> 38178354Ssam#include <sys/socket.h> 39178354Ssam#include <sys/sysctl.h> 40178354Ssam 41178354Ssam#include <net/if.h> 42178354Ssam#include <net/if_media.h> 43178354Ssam 44178354Ssam#include <net80211/ieee80211_var.h> 45178354Ssam#include <net80211/ieee80211_rssadapt.h> 46206358Srpaulo#include <net80211/ieee80211_ratectl.h> 47178354Ssam 48178354Ssamstruct rssadapt_expavgctl { 49178354Ssam /* RSS threshold decay. */ 50178354Ssam u_int rc_decay_denom; 51178354Ssam u_int rc_decay_old; 52178354Ssam /* RSS threshold update. */ 53178354Ssam u_int rc_thresh_denom; 54178354Ssam u_int rc_thresh_old; 55178354Ssam /* RSS average update. */ 56178354Ssam u_int rc_avgrssi_denom; 57178354Ssam u_int rc_avgrssi_old; 58178354Ssam}; 59178354Ssam 60178354Ssamstatic struct rssadapt_expavgctl master_expavgctl = { 61209092Sed .rc_decay_denom = 16, 62209092Sed .rc_decay_old = 15, 63209092Sed .rc_thresh_denom = 8, 64209092Sed .rc_thresh_old = 4, 65209092Sed .rc_avgrssi_denom = 8, 66209092Sed .rc_avgrssi_old = 4 67178354Ssam}; 68178354Ssam 69178354Ssam#ifdef interpolate 70178354Ssam#undef interpolate 71178354Ssam#endif 72178354Ssam#define interpolate(parm, old, new) ((parm##_old * (old) + \ 73178354Ssam (parm##_denom - parm##_old) * (new)) / \ 74178354Ssam parm##_denom) 75178354Ssam 76206358Srpaulostatic void rssadapt_setinterval(const struct ieee80211vap *, int); 77206358Srpaulostatic void rssadapt_init(struct ieee80211vap *); 78206358Srpaulostatic void rssadapt_deinit(struct ieee80211vap *); 79206358Srpaulostatic void rssadapt_updatestats(struct ieee80211_rssadapt_node *); 80206358Srpaulostatic void rssadapt_node_init(struct ieee80211_node *); 81206358Srpaulostatic void rssadapt_node_deinit(struct ieee80211_node *); 82206358Srpaulostatic int rssadapt_rate(struct ieee80211_node *, void *, uint32_t); 83206358Srpaulostatic void rssadapt_lower_rate(struct ieee80211_rssadapt_node *, int, int); 84206358Srpaulostatic void rssadapt_raise_rate(struct ieee80211_rssadapt_node *, 85206358Srpaulo int, int); 86206358Srpaulostatic void rssadapt_tx_complete(const struct ieee80211vap *, 87206358Srpaulo const struct ieee80211_node *, int, 88206358Srpaulo void *, void *); 89206358Srpaulostatic void rssadapt_sysctlattach(struct ieee80211vap *, 90206358Srpaulo struct sysctl_ctx_list *, struct sysctl_oid *); 91178354Ssam 92178354Ssam/* number of references from net80211 layer */ 93178354Ssamstatic int nrefs = 0; 94178354Ssam 95206358Srpaulostatic const struct ieee80211_ratectl rssadapt = { 96206358Srpaulo .ir_name = "rssadapt", 97206358Srpaulo .ir_attach = NULL, 98206358Srpaulo .ir_detach = NULL, 99206358Srpaulo .ir_init = rssadapt_init, 100206358Srpaulo .ir_deinit = rssadapt_deinit, 101206358Srpaulo .ir_node_init = rssadapt_node_init, 102206358Srpaulo .ir_node_deinit = rssadapt_node_deinit, 103206358Srpaulo .ir_rate = rssadapt_rate, 104206358Srpaulo .ir_tx_complete = rssadapt_tx_complete, 105206358Srpaulo .ir_tx_update = NULL, 106206358Srpaulo .ir_setinterval = rssadapt_setinterval, 107206358Srpaulo}; 108206358SrpauloIEEE80211_RATECTL_MODULE(rssadapt, 1); 109206358SrpauloIEEE80211_RATECTL_ALG(rssadapt, IEEE80211_RATECTL_RSSADAPT, rssadapt); 110206358Srpaulo 111206358Srpaulostatic void 112206358Srpaulorssadapt_setinterval(const struct ieee80211vap *vap, int msecs) 113178354Ssam{ 114206358Srpaulo struct ieee80211_rssadapt *rs = vap->iv_rs; 115178354Ssam int t; 116178354Ssam 117178354Ssam if (msecs < 100) 118178354Ssam msecs = 100; 119178354Ssam t = msecs_to_ticks(msecs); 120178354Ssam rs->interval = (t < 1) ? 1 : t; 121178354Ssam} 122178354Ssam 123206358Srpaulostatic void 124206358Srpaulorssadapt_init(struct ieee80211vap *vap) 125178354Ssam{ 126206358Srpaulo struct ieee80211_rssadapt *rs; 127206358Srpaulo 128206358Srpaulo KASSERT(vap->iv_rs == NULL, ("%s: iv_rs already initialized", 129206358Srpaulo __func__)); 130206358Srpaulo 131206419Srpaulo vap->iv_rs = rs = malloc(sizeof(struct ieee80211_rssadapt), 132206419Srpaulo M_80211_RATECTL, M_NOWAIT|M_ZERO); 133206419Srpaulo if (rs == NULL) { 134206419Srpaulo if_printf(vap->iv_ifp, "couldn't alloc ratectl structure\n"); 135206419Srpaulo return; 136206419Srpaulo } 137178354Ssam rs->vap = vap; 138206358Srpaulo rssadapt_setinterval(vap, 500 /* msecs */); 139206358Srpaulo rssadapt_sysctlattach(vap, vap->iv_sysctl, vap->iv_oid); 140178354Ssam} 141178354Ssam 142206358Srpaulostatic void 143206358Srpaulorssadapt_deinit(struct ieee80211vap *vap) 144178354Ssam{ 145206358Srpaulo free(vap->iv_rs, M_80211_RATECTL); 146178354Ssam} 147178354Ssam 148178354Ssamstatic void 149178354Ssamrssadapt_updatestats(struct ieee80211_rssadapt_node *ra) 150178354Ssam{ 151178354Ssam long interval; 152178354Ssam 153178354Ssam ra->ra_pktrate = (ra->ra_pktrate + 10*(ra->ra_nfail + ra->ra_nok))/2; 154178354Ssam ra->ra_nfail = ra->ra_nok = 0; 155178354Ssam 156178354Ssam /* 157178354Ssam * A node is eligible for its rate to be raised every 1/10 to 10 158178354Ssam * seconds, more eligible in proportion to recent packet rates. 159178354Ssam */ 160178354Ssam interval = MAX(10*1000, 10*1000 / MAX(1, 10 * ra->ra_pktrate)); 161178354Ssam ra->ra_raise_interval = msecs_to_ticks(interval); 162178354Ssam} 163178354Ssam 164206358Srpaulostatic void 165206358Srpaulorssadapt_node_init(struct ieee80211_node *ni) 166178354Ssam{ 167206358Srpaulo struct ieee80211_rssadapt_node *ra; 168206419Srpaulo struct ieee80211vap *vap = ni->ni_vap; 169206419Srpaulo struct ieee80211_rssadapt *rsa = vap->iv_rs; 170178354Ssam const struct ieee80211_rateset *rs = &ni->ni_rates; 171178354Ssam 172207323Srpaulo if (ni->ni_rctls == NULL) { 173207323Srpaulo ni->ni_rctls = ra = 174207323Srpaulo malloc(sizeof(struct ieee80211_rssadapt_node), 175207323Srpaulo M_80211_RATECTL, M_NOWAIT|M_ZERO); 176207323Srpaulo if (ra == NULL) { 177207323Srpaulo if_printf(vap->iv_ifp, "couldn't alloc per-node ratectl " 178207323Srpaulo "structure\n"); 179207323Srpaulo return; 180207323Srpaulo } 181207323Srpaulo } else 182207323Srpaulo ra = ni->ni_rctls; 183178354Ssam ra->ra_rs = rsa; 184178354Ssam ra->ra_rates = *rs; 185178354Ssam rssadapt_updatestats(ra); 186178354Ssam 187178354Ssam /* pick initial rate */ 188178354Ssam for (ra->ra_rix = rs->rs_nrates - 1; 189178354Ssam ra->ra_rix > 0 && (rs->rs_rates[ra->ra_rix] & IEEE80211_RATE_VAL) > 72; 190178354Ssam ra->ra_rix--) 191178354Ssam ; 192178354Ssam ni->ni_txrate = rs->rs_rates[ra->ra_rix] & IEEE80211_RATE_VAL; 193178354Ssam ra->ra_ticks = ticks; 194178354Ssam 195178354Ssam IEEE80211_NOTE(ni->ni_vap, IEEE80211_MSG_RATECTL, ni, 196178354Ssam "RSSADAPT initial rate %d", ni->ni_txrate); 197178354Ssam} 198178354Ssam 199206358Srpaulostatic void 200206358Srpaulorssadapt_node_deinit(struct ieee80211_node *ni) 201206358Srpaulo{ 202206358Srpaulo 203206358Srpaulo free(ni->ni_rctls, M_80211_RATECTL); 204206358Srpaulo} 205206358Srpaulo 206178354Ssamstatic __inline int 207178354Ssambucket(int pktlen) 208178354Ssam{ 209178354Ssam int i, top, thridx; 210178354Ssam 211178354Ssam for (i = 0, top = IEEE80211_RSSADAPT_BKT0; 212178354Ssam i < IEEE80211_RSSADAPT_BKTS; 213178354Ssam i++, top <<= IEEE80211_RSSADAPT_BKTPOWER) { 214178354Ssam thridx = i; 215178354Ssam if (pktlen <= top) 216178354Ssam break; 217178354Ssam } 218178354Ssam return thridx; 219178354Ssam} 220178354Ssam 221206358Srpaulostatic int 222206358Srpaulorssadapt_rate(struct ieee80211_node *ni, void *arg __unused, uint32_t iarg) 223178354Ssam{ 224206358Srpaulo struct ieee80211_rssadapt_node *ra = ni->ni_rctls; 225206358Srpaulo u_int pktlen = iarg; 226178354Ssam const struct ieee80211_rateset *rs = &ra->ra_rates; 227178354Ssam uint16_t (*thrs)[IEEE80211_RATE_SIZE]; 228178354Ssam int rix, rssi; 229178354Ssam 230178354Ssam if ((ticks - ra->ra_ticks) > ra->ra_rs->interval) { 231178354Ssam rssadapt_updatestats(ra); 232178354Ssam ra->ra_ticks = ticks; 233178354Ssam } 234178354Ssam 235178354Ssam thrs = &ra->ra_rate_thresh[bucket(pktlen)]; 236178354Ssam 237178354Ssam /* XXX this is average rssi, should be using last value */ 238178354Ssam rssi = ni->ni_ic->ic_node_getrssi(ni); 239178354Ssam for (rix = rs->rs_nrates-1; rix >= 0; rix--) 240178354Ssam if ((*thrs)[rix] < (rssi << 8)) 241178354Ssam break; 242178354Ssam if (rix != ra->ra_rix) { 243178354Ssam /* update public rate */ 244178354Ssam ni->ni_txrate = ni->ni_rates.rs_rates[rix] & IEEE80211_RATE_VAL; 245178354Ssam ra->ra_rix = rix; 246178354Ssam 247178354Ssam IEEE80211_NOTE(ni->ni_vap, IEEE80211_MSG_RATECTL, ni, 248178354Ssam "RSSADAPT new rate %d (pktlen %d rssi %d)", 249178354Ssam ni->ni_txrate, pktlen, rssi); 250178354Ssam } 251178354Ssam return rix; 252178354Ssam} 253178354Ssam 254178354Ssam/* 255178354Ssam * Adapt the data rate to suit the conditions. When a transmitted 256178354Ssam * packet is dropped after RAL_RSSADAPT_RETRY_LIMIT retransmissions, 257178354Ssam * raise the RSS threshold for transmitting packets of similar length at 258178354Ssam * the same data rate. 259178354Ssam */ 260206358Srpaulostatic void 261206358Srpaulorssadapt_lower_rate(struct ieee80211_rssadapt_node *ra, int pktlen, int rssi) 262178354Ssam{ 263178354Ssam uint16_t last_thr; 264178354Ssam uint16_t (*thrs)[IEEE80211_RATE_SIZE]; 265178354Ssam u_int rix; 266178354Ssam 267178354Ssam thrs = &ra->ra_rate_thresh[bucket(pktlen)]; 268178354Ssam 269178354Ssam rix = ra->ra_rix; 270178354Ssam last_thr = (*thrs)[rix]; 271178354Ssam (*thrs)[rix] = interpolate(master_expavgctl.rc_thresh, 272178354Ssam last_thr, (rssi << 8)); 273178354Ssam 274178354Ssam IEEE80211_DPRINTF(ra->ra_rs->vap, IEEE80211_MSG_RATECTL, 275178354Ssam "RSSADAPT lower threshold for rate %d (last_thr %d new thr %d rssi %d)\n", 276178354Ssam ra->ra_rates.rs_rates[rix + 1] & IEEE80211_RATE_VAL, 277178354Ssam last_thr, (*thrs)[rix], rssi); 278178354Ssam} 279178354Ssam 280206358Srpaulostatic void 281206358Srpaulorssadapt_raise_rate(struct ieee80211_rssadapt_node *ra, int pktlen, int rssi) 282178354Ssam{ 283178354Ssam uint16_t (*thrs)[IEEE80211_RATE_SIZE]; 284178354Ssam uint16_t newthr, oldthr; 285178354Ssam int rix; 286178354Ssam 287178354Ssam thrs = &ra->ra_rate_thresh[bucket(pktlen)]; 288178354Ssam 289178354Ssam rix = ra->ra_rix; 290178354Ssam if ((*thrs)[rix + 1] > (*thrs)[rix]) { 291178354Ssam oldthr = (*thrs)[rix + 1]; 292178354Ssam if ((*thrs)[rix] == 0) 293178354Ssam newthr = (rssi << 8); 294178354Ssam else 295178354Ssam newthr = (*thrs)[rix]; 296178354Ssam (*thrs)[rix + 1] = interpolate(master_expavgctl.rc_decay, 297178354Ssam oldthr, newthr); 298178354Ssam 299178354Ssam IEEE80211_DPRINTF(ra->ra_rs->vap, IEEE80211_MSG_RATECTL, 300178354Ssam "RSSADAPT raise threshold for rate %d (oldthr %d newthr %d rssi %d)\n", 301178354Ssam ra->ra_rates.rs_rates[rix + 1] & IEEE80211_RATE_VAL, 302178354Ssam oldthr, newthr, rssi); 303178354Ssam 304178354Ssam ra->ra_last_raise = ticks; 305178354Ssam } 306178354Ssam} 307178354Ssam 308206358Srpaulostatic void 309206358Srpaulorssadapt_tx_complete(const struct ieee80211vap *vap, 310206358Srpaulo const struct ieee80211_node *ni, int success, void *arg1, void *arg2) 311206358Srpaulo{ 312206358Srpaulo struct ieee80211_rssadapt_node *ra = ni->ni_rctls; 313206358Srpaulo int pktlen = *(int *)arg1, rssi = *(int *)arg2; 314206358Srpaulo 315206358Srpaulo if (success) { 316206358Srpaulo ra->ra_nok++; 317206358Srpaulo if ((ra->ra_rix + 1) < ra->ra_rates.rs_nrates && 318206358Srpaulo (ticks - ra->ra_last_raise) >= ra->ra_raise_interval) 319206358Srpaulo rssadapt_raise_rate(ra, pktlen, rssi); 320206358Srpaulo } else { 321206358Srpaulo ra->ra_nfail++; 322206358Srpaulo rssadapt_lower_rate(ra, pktlen, rssi); 323206358Srpaulo } 324206358Srpaulo} 325206358Srpaulo 326178354Ssamstatic int 327178354Ssamrssadapt_sysctl_interval(SYSCTL_HANDLER_ARGS) 328178354Ssam{ 329206358Srpaulo struct ieee80211vap *vap = arg1; 330206358Srpaulo struct ieee80211_rssadapt *rs = vap->iv_rs; 331178354Ssam int msecs = ticks_to_msecs(rs->interval); 332178354Ssam int error; 333178354Ssam 334178354Ssam error = sysctl_handle_int(oidp, &msecs, 0, req); 335178354Ssam if (error || !req->newptr) 336178354Ssam return error; 337206358Srpaulo rssadapt_setinterval(vap, msecs); 338178354Ssam return 0; 339178354Ssam} 340178354Ssam 341178354Ssamstatic void 342206358Srpaulorssadapt_sysctlattach(struct ieee80211vap *vap, 343178354Ssam struct sysctl_ctx_list *ctx, struct sysctl_oid *tree) 344178354Ssam{ 345178354Ssam 346178354Ssam SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(tree), OID_AUTO, 347206358Srpaulo "rssadapt_rate_interval", CTLTYPE_INT | CTLFLAG_RW, vap, 348178354Ssam 0, rssadapt_sysctl_interval, "I", "rssadapt operation interval (ms)"); 349178354Ssam} 350