SAFE public projects git trees. - safe/jmp/linux-2.6/blob - net/mac80211/rc80211_minstrel.c

   1 /*
   2  * Copyright (C) 2008 Felix Fietkau <nbd@openwrt.org>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License version 2 as
   6  * published by the Free Software Foundation.
   7  *
   8  * Based on minstrel.c:
   9  *   Copyright (C) 2005-2007 Derek Smithies <derek@indranet.co.nz>
  10  *   Sponsored by Indranet Technologies Ltd
  11  *
  12  * Based on sample.c:
  13  *   Copyright (c) 2005 John Bicket
  14  *   All rights reserved.
  15  *
  16  *   Redistribution and use in source and binary forms, with or without
  17  *   modification, are permitted provided that the following conditions
  18  *   are met:
  19  *   1. Redistributions of source code must retain the above copyright
  20  *      notice, this list of conditions and the following disclaimer,
  21  *      without modification.
  22  *   2. Redistributions in binary form must reproduce at minimum a disclaimer
  23  *      similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
  24  *      redistribution must be conditioned upon including a substantially
  25  *      similar Disclaimer requirement for further binary redistribution.
  26  *   3. Neither the names of the above-listed copyright holders nor the names
  27  *      of any contributors may be used to endorse or promote products derived
  28  *      from this software without specific prior written permission.
  29  *
  30  *   Alternatively, this software may be distributed under the terms of the
  31  *   GNU General Public License ("GPL") version 2 as published by the Free
  32  *   Software Foundation.
  33  *
  34  *   NO WARRANTY
  35  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  36  *   ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  37  *   LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
  38  *   AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
  39  *   THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
  40  *   OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  41  *   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  42  *   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  43  *   IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  44  *   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  45  *   THE POSSIBILITY OF SUCH DAMAGES.
  46  */
  47 #include <linux/netdevice.h>
  48 #include <linux/types.h>
  49 #include <linux/skbuff.h>
  50 #include <linux/debugfs.h>
  51 #include <linux/random.h>
  52 #include <linux/ieee80211.h>
  53 #include <net/mac80211.h>
  54 #include "rate.h"
  55 #include "rc80211_minstrel.h"
  56
  57 #define SAMPLE_COLUMNS  10
  58 #define SAMPLE_TBL(_mi, _idx, _col) \
  59                 _mi->sample_table[(_idx * SAMPLE_COLUMNS) + _col]
  60
  61 /* convert mac80211 rate index to local array index */
  62 static inline int
  63 rix_to_ndx(struct minstrel_sta_info *mi, int rix)
  64 {
  65         int i = rix;
  66         for (i = rix; i >= 0; i--)
  67                 if (mi->r[i].rix == rix)
  68                         break;
  69         WARN_ON(i < 0);
  70         return i;
  71 }
  72
  73 static inline bool
  74 use_low_rate(struct sk_buff *skb)
  75 {
  76         struct ieee80211_hdr *hdr = (struct ieee80211_hdr *) skb->data;
  77         struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
  78         __le16 fc;
  79
  80         fc = hdr->frame_control;
  81
  82         return ((info->flags & IEEE80211_TX_CTL_NO_ACK) || !ieee80211_is_data(fc));
  83 }
  84
  85
  86 static void
  87 minstrel_update_stats(struct minstrel_priv *mp, struct minstrel_sta_info *mi)
  88 {
  89         u32 max_tp = 0, index_max_tp = 0, index_max_tp2 = 0;
  90         u32 max_prob = 0, index_max_prob = 0;
  91         u32 usecs;
  92         u32 p;
  93         int i;
  94
  95         mi->stats_update = jiffies;
  96         for (i = 0; i < mi->n_rates; i++) {
  97                 struct minstrel_rate *mr = &mi->r[i];
  98
  99                 usecs = mr->perfect_tx_time;
 100                 if (!usecs)
 101                         usecs = 1000000;
 102
 103                 /* To avoid rounding issues, probabilities scale from 0 (0%)
 104                  * to 18000 (100%) */
 105                 if (mr->attempts) {
 106                         p = (mr->success * 18000) / mr->attempts;
 107                         mr->succ_hist += mr->success;
 108                         mr->att_hist += mr->attempts;
 109                         mr->cur_prob = p;
 110                         p = ((p * (100 - mp->ewma_level)) + (mr->probability *
 111                                 mp->ewma_level)) / 100;
 112                         mr->probability = p;
 113                         mr->cur_tp = p * (1000000 / usecs);
 114                 }
 115
 116                 mr->last_success = mr->success;
 117                 mr->last_attempts = mr->attempts;
 118                 mr->success = 0;
 119                 mr->attempts = 0;
 120
 121                 /* Sample less often below the 10% chance of success.
 122                  * Sample less often above the 95% chance of success. */
 123                 if ((mr->probability > 17100) || (mr->probability < 1800)) {
 124                         mr->adjusted_retry_count = mr->retry_count >> 1;
 125                         if (mr->adjusted_retry_count > 2)
 126                                 mr->adjusted_retry_count = 2;
 127                         mr->sample_limit = 4;
 128                 } else {
 129                         mr->sample_limit = -1;
 130                         mr->adjusted_retry_count = mr->retry_count;
 131                 }
 132                 if (!mr->adjusted_retry_count)
 133                         mr->adjusted_retry_count = 2;
 134         }
 135
 136         for (i = 0; i < mi->n_rates; i++) {
 137                 struct minstrel_rate *mr = &mi->r[i];
 138                 if (max_tp < mr->cur_tp) {
 139                         index_max_tp = i;
 140                         max_tp = mr->cur_tp;
 141                 }
 142                 if (max_prob < mr->probability) {
 143                         index_max_prob = i;
 144                         max_prob = mr->probability;
 145                 }
 146         }
 147
 148         max_tp = 0;
 149         for (i = 0; i < mi->n_rates; i++) {
 150                 struct minstrel_rate *mr = &mi->r[i];
 151
 152                 if (i == index_max_tp)
 153                         continue;
 154
 155                 if (max_tp < mr->cur_tp) {
 156                         index_max_tp2 = i;
 157                         max_tp = mr->cur_tp;
 158                 }
 159         }
 160         mi->max_tp_rate = index_max_tp;
 161         mi->max_tp_rate2 = index_max_tp2;
 162         mi->max_prob_rate = index_max_prob;
 163 }
 164
 165 static void
 166 minstrel_tx_status(void *priv, struct ieee80211_supported_band *sband,
 167                    struct ieee80211_sta *sta, void *priv_sta,
 168                    struct sk_buff *skb)
 169 {
 170         struct minstrel_sta_info *mi = priv_sta;
 171         struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
 172         struct ieee80211_tx_rate *ar = info->status.rates;
 173         int i, ndx;
 174         int success;
 175
 176         success = !!(info->flags & IEEE80211_TX_STAT_ACK);
 177
 178         for (i = 0; i < IEEE80211_TX_MAX_RATES; i++) {
 179                 if (ar[i].idx < 0)
 180                         break;
 181
 182                 ndx = rix_to_ndx(mi, ar[i].idx);
 183                 if (ndx < 0)
 184                         continue;
 185
 186                 mi->r[ndx].attempts += ar[i].count;
 187
 188                 if ((i != IEEE80211_TX_MAX_RATES - 1) && (ar[i + 1].idx < 0))
 189                         mi->r[ndx].success += success;
 190         }
 191
 192         if ((info->flags & IEEE80211_TX_CTL_RATE_CTRL_PROBE) && (i >= 0))
 193                 mi->sample_count++;
 194
 195         if (mi->sample_deferred > 0)
 196                 mi->sample_deferred--;
 197 }
 198
 199
 200 static inline unsigned int
 201 minstrel_get_retry_count(struct minstrel_rate *mr,
 202                          struct ieee80211_tx_info *info)
 203 {
 204         unsigned int retry = mr->adjusted_retry_count;
 205
 206         if (info->control.rates[0].flags & IEEE80211_TX_RC_USE_RTS_CTS)
 207                 retry = max(2U, min(mr->retry_count_rtscts, retry));
 208         else if (info->control.rates[0].flags & IEEE80211_TX_RC_USE_CTS_PROTECT)
 209                 retry = max(2U, min(mr->retry_count_cts, retry));
 210         return retry;
 211 }
 212
 213
 214 static int
 215 minstrel_get_next_sample(struct minstrel_sta_info *mi)
 216 {
 217         unsigned int sample_ndx;
 218         sample_ndx = SAMPLE_TBL(mi, mi->sample_idx, mi->sample_column);
 219         mi->sample_idx++;
 220         if ((int) mi->sample_idx > (mi->n_rates - 2)) {
 221                 mi->sample_idx = 0;
 222                 mi->sample_column++;
 223                 if (mi->sample_column >= SAMPLE_COLUMNS)
 224                         mi->sample_column = 0;
 225         }
 226         return sample_ndx;
 227 }
 228
 229 static void
 230 minstrel_get_rate(void *priv, struct ieee80211_sta *sta,
 231                   void *priv_sta, struct ieee80211_tx_rate_control *txrc)
 232 {
 233         struct sk_buff *skb = txrc->skb;
 234         struct ieee80211_supported_band *sband = txrc->sband;
 235         struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
 236         struct minstrel_sta_info *mi = priv_sta;
 237         struct minstrel_priv *mp = priv;
 238         struct ieee80211_tx_rate *ar = info->control.rates;
 239         unsigned int ndx, sample_ndx = 0;
 240         bool mrr;
 241         bool sample_slower = false;
 242         bool sample = false;
 243         int i, delta;
 244         int mrr_ndx[3];
 245         int sample_rate;
 246
 247         if (!sta || !mi || use_low_rate(skb)) {
 248                 ar[0].idx = rate_lowest_index(sband, sta);
 249                 if (info->flags & IEEE80211_TX_CTL_NO_ACK)
 250                         ar[0].count = 1;
 251                 else
 252                         ar[0].count = mp->max_retry;
 253                 return;
 254         }
 255
 256         mrr = mp->has_mrr && !txrc->rts && !txrc->bss_conf->use_cts_prot;
 257
 258         if (time_after(jiffies, mi->stats_update + (mp->update_interval *
 259                         HZ) / 1000))
 260                 minstrel_update_stats(mp, mi);
 261
 262         ndx = mi->max_tp_rate;
 263
 264         if (mrr)
 265                 sample_rate = mp->lookaround_rate_mrr;
 266         else
 267                 sample_rate = mp->lookaround_rate;
 268
 269         mi->packet_count++;
 270         delta = (mi->packet_count * sample_rate / 100) -
 271                         (mi->sample_count + mi->sample_deferred / 2);
 272
 273         /* delta > 0: sampling required */
 274         if ((delta > 0) && (mrr || !mi->prev_sample)) {
 275                 struct minstrel_rate *msr;
 276                 if (mi->packet_count >= 10000) {
 277                         mi->sample_deferred = 0;
 278                         mi->sample_count = 0;
 279                         mi->packet_count = 0;
 280                 } else if (delta > mi->n_rates * 2) {
 281                         /* With multi-rate retry, not every planned sample
 282                          * attempt actually gets used, due to the way the retry
 283                          * chain is set up - [max_tp,sample,prob,lowest] for
 284                          * sample_rate < max_tp.
 285                          *
 286                          * If there's too much sampling backlog and the link
 287                          * starts getting worse, minstrel would start bursting
 288                          * out lots of sampling frames, which would result
 289                          * in a large throughput loss. */
 290                         mi->sample_count += (delta - mi->n_rates * 2);
 291                 }
 292
 293                 sample_ndx = minstrel_get_next_sample(mi);
 294                 msr = &mi->r[sample_ndx];
 295                 sample = true;
 296                 sample_slower = mrr && (msr->perfect_tx_time >
 297                         mi->r[ndx].perfect_tx_time);
 298
 299                 if (!sample_slower) {
 300                         if (msr->sample_limit != 0) {
 301                                 ndx = sample_ndx;
 302                                 mi->sample_count++;
 303                                 if (msr->sample_limit > 0)
 304                                         msr->sample_limit--;
 305                         } else {
 306                                 sample = false;
 307                         }
 308                 } else {
 309                         /* Only use IEEE80211_TX_CTL_RATE_CTRL_PROBE to mark
 310                          * packets that have the sampling rate deferred to the
 311                          * second MRR stage. Increase the sample counter only
 312                          * if the deferred sample rate was actually used.
 313                          * Use the sample_deferred counter to make sure that
 314                          * the sampling is not done in large bursts */
 315                         info->flags |= IEEE80211_TX_CTL_RATE_CTRL_PROBE;
 316                         mi->sample_deferred++;
 317                 }
 318         }
 319         mi->prev_sample = sample;
 320
 321         /* If we're not using MRR and the sampling rate already
 322          * has a probability of >95%, we shouldn't be attempting
 323          * to use it, as this only wastes precious airtime */
 324         if (!mrr && sample && (mi->r[ndx].probability > 17100))
 325                 ndx = mi->max_tp_rate;
 326
 327         ar[0].idx = mi->r[ndx].rix;
 328         ar[0].count = minstrel_get_retry_count(&mi->r[ndx], info);
 329
 330         if (!mrr) {
 331                 if (!sample)
 332                         ar[0].count = mp->max_retry;
 333                 ar[1].idx = mi->lowest_rix;
 334                 ar[1].count = mp->max_retry;
 335                 return;
 336         }
 337
 338         /* MRR setup */
 339         if (sample) {
 340                 if (sample_slower)
 341                         mrr_ndx[0] = sample_ndx;
 342                 else
 343                         mrr_ndx[0] = mi->max_tp_rate;
 344         } else {
 345                 mrr_ndx[0] = mi->max_tp_rate2;
 346         }
 347         mrr_ndx[1] = mi->max_prob_rate;
 348         mrr_ndx[2] = 0;
 349         for (i = 1; i < 4; i++) {
 350                 ar[i].idx = mi->r[mrr_ndx[i - 1]].rix;
 351                 ar[i].count = mi->r[mrr_ndx[i - 1]].adjusted_retry_count;
 352         }
 353 }
 354
 355
 356 static void
 357 calc_rate_durations(struct minstrel_sta_info *mi, struct ieee80211_local *local,
 358                     struct minstrel_rate *d, struct ieee80211_rate *rate)
 359 {
 360         int erp = !!(rate->flags & IEEE80211_RATE_ERP_G);
 361
 362         d->perfect_tx_time = ieee80211_frame_duration(local, 1200,
 363                         rate->bitrate, erp, 1);
 364         d->ack_time = ieee80211_frame_duration(local, 10,
 365                         rate->bitrate, erp, 1);
 366 }
 367
 368 static void
 369 init_sample_table(struct minstrel_sta_info *mi)
 370 {
 371         unsigned int i, col, new_idx;
 372         unsigned int n_srates = mi->n_rates - 1;
 373         u8 rnd[8];
 374
 375         mi->sample_column = 0;
 376         mi->sample_idx = 0;
 377         memset(mi->sample_table, 0, SAMPLE_COLUMNS * mi->n_rates);
 378
 379         for (col = 0; col < SAMPLE_COLUMNS; col++) {
 380                 for (i = 0; i < n_srates; i++) {
 381                         get_random_bytes(rnd, sizeof(rnd));
 382                         new_idx = (i + rnd[i & 7]) % n_srates;
 383
 384                         while (SAMPLE_TBL(mi, new_idx, col) != 0)
 385                                 new_idx = (new_idx + 1) % n_srates;
 386
 387                         /* Don't sample the slowest rate (i.e. slowest base
 388                          * rate). We must presume that the slowest rate works
 389                          * fine, or else other management frames will also be
 390                          * failing and the link will break */
 391                         SAMPLE_TBL(mi, new_idx, col) = i + 1;
 392                 }
 393         }
 394 }
 395
 396 static void
 397 minstrel_rate_init(void *priv, struct ieee80211_supported_band *sband,
 398                struct ieee80211_sta *sta, void *priv_sta)
 399 {
 400         struct minstrel_sta_info *mi = priv_sta;
 401         struct minstrel_priv *mp = priv;
 402         struct ieee80211_local *local = hw_to_local(mp->hw);
 403         struct ieee80211_rate *ctl_rate;
 404         unsigned int i, n = 0;
 405         unsigned int t_slot = 9; /* FIXME: get real slot time */
 406
 407         mi->lowest_rix = rate_lowest_index(sband, sta);
 408         ctl_rate = &sband->bitrates[mi->lowest_rix];
 409         mi->sp_ack_dur = ieee80211_frame_duration(local, 10, ctl_rate->bitrate,
 410                                 !!(ctl_rate->flags & IEEE80211_RATE_ERP_G), 1);
 411
 412         for (i = 0; i < sband->n_bitrates; i++) {
 413                 struct minstrel_rate *mr = &mi->r[n];
 414                 unsigned int tx_time = 0, tx_time_cts = 0, tx_time_rtscts = 0;
 415                 unsigned int tx_time_single;
 416                 unsigned int cw = mp->cw_min;
 417
 418                 if (!rate_supported(sta, sband->band, i))
 419                         continue;
 420                 n++;
 421                 memset(mr, 0, sizeof(*mr));
 422
 423                 mr->rix = i;
 424                 mr->bitrate = sband->bitrates[i].bitrate / 5;
 425                 calc_rate_durations(mi, local, mr,
 426                                 &sband->bitrates[i]);
 427
 428                 /* calculate maximum number of retransmissions before
 429                  * fallback (based on maximum segment size) */
 430                 mr->sample_limit = -1;
 431                 mr->retry_count = 1;
 432                 mr->retry_count_cts = 1;
 433                 mr->retry_count_rtscts = 1;
 434                 tx_time = mr->perfect_tx_time + mi->sp_ack_dur;
 435                 do {
 436                         /* add one retransmission */
 437                         tx_time_single = mr->ack_time + mr->perfect_tx_time;
 438
 439                         /* contention window */
 440                         tx_time_single += t_slot + min(cw, mp->cw_max);
 441                         cw = (cw + 1) << 1;
 442
 443                         tx_time += tx_time_single;
 444                         tx_time_cts += tx_time_single + mi->sp_ack_dur;
 445                         tx_time_rtscts += tx_time_single + 2 * mi->sp_ack_dur;
 446                         if ((tx_time_cts < mp->segment_size) &&
 447                                 (mr->retry_count_cts < mp->max_retry))
 448                                 mr->retry_count_cts++;
 449                         if ((tx_time_rtscts < mp->segment_size) &&
 450                                 (mr->retry_count_rtscts < mp->max_retry))
 451                                 mr->retry_count_rtscts++;
 452                 } while ((tx_time < mp->segment_size) &&
 453                                 (++mr->retry_count < mp->max_retry));
 454                 mr->adjusted_retry_count = mr->retry_count;
 455         }
 456
 457         for (i = n; i < sband->n_bitrates; i++) {
 458                 struct minstrel_rate *mr = &mi->r[i];
 459                 mr->rix = -1;
 460         }
 461
 462         mi->n_rates = n;
 463         mi->stats_update = jiffies;
 464
 465         init_sample_table(mi);
 466 }
 467
 468 static void *
 469 minstrel_alloc_sta(void *priv, struct ieee80211_sta *sta, gfp_t gfp)
 470 {
 471         struct ieee80211_supported_band *sband;
 472         struct minstrel_sta_info *mi;
 473         struct minstrel_priv *mp = priv;
 474         struct ieee80211_hw *hw = mp->hw;
 475         int max_rates = 0;
 476         int i;
 477
 478         mi = kzalloc(sizeof(struct minstrel_sta_info), gfp);
 479         if (!mi)
 480                 return NULL;
 481
 482         for (i = 0; i < IEEE80211_NUM_BANDS; i++) {
 483                 sband = hw->wiphy->bands[i];
 484                 if (sband && sband->n_bitrates > max_rates)
 485                         max_rates = sband->n_bitrates;
 486         }
 487
 488         mi->r = kzalloc(sizeof(struct minstrel_rate) * max_rates, gfp);
 489         if (!mi->r)
 490                 goto error;
 491
 492         mi->sample_table = kmalloc(SAMPLE_COLUMNS * max_rates, gfp);
 493         if (!mi->sample_table)
 494                 goto error1;
 495
 496         mi->stats_update = jiffies;
 497         return mi;
 498
 499 error1:
 500         kfree(mi->r);
 501 error:
 502         kfree(mi);
 503         return NULL;
 504 }
 505
 506 static void
 507 minstrel_free_sta(void *priv, struct ieee80211_sta *sta, void *priv_sta)
 508 {
 509         struct minstrel_sta_info *mi = priv_sta;
 510
 511         kfree(mi->sample_table);
 512         kfree(mi->r);
 513         kfree(mi);
 514 }
 515
 516 static void *
 517 minstrel_alloc(struct ieee80211_hw *hw, struct dentry *debugfsdir)
 518 {
 519         struct minstrel_priv *mp;
 520
 521         mp = kzalloc(sizeof(struct minstrel_priv), GFP_ATOMIC);
 522         if (!mp)
 523                 return NULL;
 524
 525         /* contention window settings
 526          * Just an approximation. Using the per-queue values would complicate
 527          * the calculations and is probably unnecessary */
 528         mp->cw_min = 15;
 529         mp->cw_max = 1023;
 530
 531         /* number of packets (in %) to use for sampling other rates
 532          * sample less often for non-mrr packets, because the overhead
 533          * is much higher than with mrr */
 534         mp->lookaround_rate = 5;
 535         mp->lookaround_rate_mrr = 10;
 536
 537         /* moving average weight for EWMA */
 538         mp->ewma_level = 75;
 539
 540         /* maximum time that the hw is allowed to stay in one MRR segment */
 541         mp->segment_size = 6000;
 542
 543         if (hw->max_rate_tries > 0)
 544                 mp->max_retry = hw->max_rate_tries;
 545         else
 546                 /* safe default, does not necessarily have to match hw properties */
 547                 mp->max_retry = 7;
 548
 549         if (hw->max_rates >= 4)
 550                 mp->has_mrr = true;
 551
 552         mp->hw = hw;
 553         mp->update_interval = 100;
 554
 555         return mp;
 556 }
 557
 558 static void
 559 minstrel_free(void *priv)
 560 {
 561         kfree(priv);
 562 }
 563
 564 static struct rate_control_ops mac80211_minstrel = {
 565         .name = "minstrel",
 566         .tx_status = minstrel_tx_status,
 567         .get_rate = minstrel_get_rate,
 568         .rate_init = minstrel_rate_init,
 569         .alloc = minstrel_alloc,
 570         .free = minstrel_free,
 571         .alloc_sta = minstrel_alloc_sta,
 572         .free_sta = minstrel_free_sta,
 573 #ifdef CONFIG_MAC80211_DEBUGFS
 574         .add_sta_debugfs = minstrel_add_sta_debugfs,
 575         .remove_sta_debugfs = minstrel_remove_sta_debugfs,
 576 #endif
 577 };
 578
 579 int __init
 580 rc80211_minstrel_init(void)
 581 {
 582         return ieee80211_rate_control_register(&mac80211_minstrel);
 583 }
 584
 585 void
 586 rc80211_minstrel_exit(void)
 587 {
 588         ieee80211_rate_control_unregister(&mac80211_minstrel);
 589 }
 590