Merge tag 'nfs-for-3.9-2' of git://git.linux-nfs.org/projects/trondmy/linux-nfs
[pandora-kernel.git] / 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 <linux/slab.h>
54 #include <net/mac80211.h>
55 #include "rate.h"
56 #include "rc80211_minstrel.h"
57
58 #define SAMPLE_COLUMNS  10
59 #define SAMPLE_TBL(_mi, _idx, _col) \
60                 _mi->sample_table[(_idx * SAMPLE_COLUMNS) + _col]
61
62 /* convert mac80211 rate index to local array index */
63 static inline int
64 rix_to_ndx(struct minstrel_sta_info *mi, int rix)
65 {
66         int i = rix;
67         for (i = rix; i >= 0; i--)
68                 if (mi->r[i].rix == rix)
69                         break;
70         return i;
71 }
72
73 static void
74 minstrel_update_stats(struct minstrel_priv *mp, struct minstrel_sta_info *mi)
75 {
76         u32 max_tp = 0, index_max_tp = 0, index_max_tp2 = 0;
77         u32 max_prob = 0, index_max_prob = 0;
78         u32 usecs;
79         u32 p;
80         int i;
81
82         mi->stats_update = jiffies;
83         for (i = 0; i < mi->n_rates; i++) {
84                 struct minstrel_rate *mr = &mi->r[i];
85
86                 usecs = mr->perfect_tx_time;
87                 if (!usecs)
88                         usecs = 1000000;
89
90                 /* To avoid rounding issues, probabilities scale from 0 (0%)
91                  * to 18000 (100%) */
92                 if (mr->attempts) {
93                         p = (mr->success * 18000) / mr->attempts;
94                         mr->succ_hist += mr->success;
95                         mr->att_hist += mr->attempts;
96                         mr->cur_prob = p;
97                         p = ((p * (100 - mp->ewma_level)) + (mr->probability *
98                                 mp->ewma_level)) / 100;
99                         mr->probability = p;
100                         mr->cur_tp = p * (1000000 / usecs);
101                 }
102
103                 mr->last_success = mr->success;
104                 mr->last_attempts = mr->attempts;
105                 mr->success = 0;
106                 mr->attempts = 0;
107
108                 /* Sample less often below the 10% chance of success.
109                  * Sample less often above the 95% chance of success. */
110                 if ((mr->probability > 17100) || (mr->probability < 1800)) {
111                         mr->adjusted_retry_count = mr->retry_count >> 1;
112                         if (mr->adjusted_retry_count > 2)
113                                 mr->adjusted_retry_count = 2;
114                         mr->sample_limit = 4;
115                 } else {
116                         mr->sample_limit = -1;
117                         mr->adjusted_retry_count = mr->retry_count;
118                 }
119                 if (!mr->adjusted_retry_count)
120                         mr->adjusted_retry_count = 2;
121         }
122
123         for (i = 0; i < mi->n_rates; i++) {
124                 struct minstrel_rate *mr = &mi->r[i];
125                 if (max_tp < mr->cur_tp) {
126                         index_max_tp = i;
127                         max_tp = mr->cur_tp;
128                 }
129                 if (max_prob < mr->probability) {
130                         index_max_prob = i;
131                         max_prob = mr->probability;
132                 }
133         }
134
135         max_tp = 0;
136         for (i = 0; i < mi->n_rates; i++) {
137                 struct minstrel_rate *mr = &mi->r[i];
138
139                 if (i == index_max_tp)
140                         continue;
141
142                 if (max_tp < mr->cur_tp) {
143                         index_max_tp2 = i;
144                         max_tp = mr->cur_tp;
145                 }
146         }
147         mi->max_tp_rate = index_max_tp;
148         mi->max_tp_rate2 = index_max_tp2;
149         mi->max_prob_rate = index_max_prob;
150 }
151
152 static void
153 minstrel_tx_status(void *priv, struct ieee80211_supported_band *sband,
154                    struct ieee80211_sta *sta, void *priv_sta,
155                    struct sk_buff *skb)
156 {
157         struct minstrel_priv *mp = priv;
158         struct minstrel_sta_info *mi = priv_sta;
159         struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
160         struct ieee80211_tx_rate *ar = info->status.rates;
161         int i, ndx;
162         int success;
163
164         success = !!(info->flags & IEEE80211_TX_STAT_ACK);
165
166         for (i = 0; i < IEEE80211_TX_MAX_RATES; i++) {
167                 if (ar[i].idx < 0)
168                         break;
169
170                 ndx = rix_to_ndx(mi, ar[i].idx);
171                 if (ndx < 0)
172                         continue;
173
174                 mi->r[ndx].attempts += ar[i].count;
175
176                 if ((i != IEEE80211_TX_MAX_RATES - 1) && (ar[i + 1].idx < 0))
177                         mi->r[ndx].success += success;
178         }
179
180         if ((info->flags & IEEE80211_TX_CTL_RATE_CTRL_PROBE) && (i >= 0))
181                 mi->sample_count++;
182
183         if (mi->sample_deferred > 0)
184                 mi->sample_deferred--;
185
186         if (time_after(jiffies, mi->stats_update +
187                                 (mp->update_interval * HZ) / 1000))
188                 minstrel_update_stats(mp, mi);
189 }
190
191
192 static inline unsigned int
193 minstrel_get_retry_count(struct minstrel_rate *mr,
194                          struct ieee80211_tx_info *info)
195 {
196         unsigned int retry = mr->adjusted_retry_count;
197
198         if (info->control.rates[0].flags & IEEE80211_TX_RC_USE_RTS_CTS)
199                 retry = max(2U, min(mr->retry_count_rtscts, retry));
200         else if (info->control.rates[0].flags & IEEE80211_TX_RC_USE_CTS_PROTECT)
201                 retry = max(2U, min(mr->retry_count_cts, retry));
202         return retry;
203 }
204
205
206 static int
207 minstrel_get_next_sample(struct minstrel_sta_info *mi)
208 {
209         unsigned int sample_ndx;
210         sample_ndx = SAMPLE_TBL(mi, mi->sample_idx, mi->sample_column);
211         mi->sample_idx++;
212         if ((int) mi->sample_idx > (mi->n_rates - 2)) {
213                 mi->sample_idx = 0;
214                 mi->sample_column++;
215                 if (mi->sample_column >= SAMPLE_COLUMNS)
216                         mi->sample_column = 0;
217         }
218         return sample_ndx;
219 }
220
221 static void
222 minstrel_get_rate(void *priv, struct ieee80211_sta *sta,
223                   void *priv_sta, struct ieee80211_tx_rate_control *txrc)
224 {
225         struct sk_buff *skb = txrc->skb;
226         struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
227         struct minstrel_sta_info *mi = priv_sta;
228         struct minstrel_priv *mp = priv;
229         struct ieee80211_tx_rate *ar = info->control.rates;
230         unsigned int ndx, sample_ndx = 0;
231         bool mrr;
232         bool sample_slower = false;
233         bool sample = false;
234         int i, delta;
235         int mrr_ndx[3];
236         int sample_rate;
237
238         if (rate_control_send_low(sta, priv_sta, txrc))
239                 return;
240
241         mrr = mp->has_mrr && !txrc->rts && !txrc->bss_conf->use_cts_prot;
242
243         ndx = mi->max_tp_rate;
244
245         if (mrr)
246                 sample_rate = mp->lookaround_rate_mrr;
247         else
248                 sample_rate = mp->lookaround_rate;
249
250         mi->packet_count++;
251         delta = (mi->packet_count * sample_rate / 100) -
252                         (mi->sample_count + mi->sample_deferred / 2);
253
254         /* delta > 0: sampling required */
255         if ((delta > 0) && (mrr || !mi->prev_sample)) {
256                 struct minstrel_rate *msr;
257                 if (mi->packet_count >= 10000) {
258                         mi->sample_deferred = 0;
259                         mi->sample_count = 0;
260                         mi->packet_count = 0;
261                 } else if (delta > mi->n_rates * 2) {
262                         /* With multi-rate retry, not every planned sample
263                          * attempt actually gets used, due to the way the retry
264                          * chain is set up - [max_tp,sample,prob,lowest] for
265                          * sample_rate < max_tp.
266                          *
267                          * If there's too much sampling backlog and the link
268                          * starts getting worse, minstrel would start bursting
269                          * out lots of sampling frames, which would result
270                          * in a large throughput loss. */
271                         mi->sample_count += (delta - mi->n_rates * 2);
272                 }
273
274                 sample_ndx = minstrel_get_next_sample(mi);
275                 msr = &mi->r[sample_ndx];
276                 sample = true;
277                 sample_slower = mrr && (msr->perfect_tx_time >
278                         mi->r[ndx].perfect_tx_time);
279
280                 if (!sample_slower) {
281                         if (msr->sample_limit != 0) {
282                                 ndx = sample_ndx;
283                                 mi->sample_count++;
284                                 if (msr->sample_limit > 0)
285                                         msr->sample_limit--;
286                         } else {
287                                 sample = false;
288                         }
289                 } else {
290                         /* Only use IEEE80211_TX_CTL_RATE_CTRL_PROBE to mark
291                          * packets that have the sampling rate deferred to the
292                          * second MRR stage. Increase the sample counter only
293                          * if the deferred sample rate was actually used.
294                          * Use the sample_deferred counter to make sure that
295                          * the sampling is not done in large bursts */
296                         info->flags |= IEEE80211_TX_CTL_RATE_CTRL_PROBE;
297                         mi->sample_deferred++;
298                 }
299         }
300         mi->prev_sample = sample;
301
302         /* If we're not using MRR and the sampling rate already
303          * has a probability of >95%, we shouldn't be attempting
304          * to use it, as this only wastes precious airtime */
305         if (!mrr && sample && (mi->r[ndx].probability > 17100))
306                 ndx = mi->max_tp_rate;
307
308         ar[0].idx = mi->r[ndx].rix;
309         ar[0].count = minstrel_get_retry_count(&mi->r[ndx], info);
310
311         if (!mrr) {
312                 if (!sample)
313                         ar[0].count = mp->max_retry;
314                 ar[1].idx = mi->lowest_rix;
315                 ar[1].count = mp->max_retry;
316                 return;
317         }
318
319         /* MRR setup */
320         if (sample) {
321                 if (sample_slower)
322                         mrr_ndx[0] = sample_ndx;
323                 else
324                         mrr_ndx[0] = mi->max_tp_rate;
325         } else {
326                 mrr_ndx[0] = mi->max_tp_rate2;
327         }
328         mrr_ndx[1] = mi->max_prob_rate;
329         mrr_ndx[2] = 0;
330         for (i = 1; i < 4; i++) {
331                 ar[i].idx = mi->r[mrr_ndx[i - 1]].rix;
332                 ar[i].count = mi->r[mrr_ndx[i - 1]].adjusted_retry_count;
333         }
334 }
335
336
337 static void
338 calc_rate_durations(enum ieee80211_band band,
339                     struct minstrel_rate *d,
340                     struct ieee80211_rate *rate)
341 {
342         int erp = !!(rate->flags & IEEE80211_RATE_ERP_G);
343
344         d->perfect_tx_time = ieee80211_frame_duration(band, 1200,
345                         rate->bitrate, erp, 1);
346         d->ack_time = ieee80211_frame_duration(band, 10,
347                         rate->bitrate, erp, 1);
348 }
349
350 static void
351 init_sample_table(struct minstrel_sta_info *mi)
352 {
353         unsigned int i, col, new_idx;
354         unsigned int n_srates = mi->n_rates - 1;
355         u8 rnd[8];
356
357         mi->sample_column = 0;
358         mi->sample_idx = 0;
359         memset(mi->sample_table, 0, SAMPLE_COLUMNS * mi->n_rates);
360
361         for (col = 0; col < SAMPLE_COLUMNS; col++) {
362                 for (i = 0; i < n_srates; i++) {
363                         get_random_bytes(rnd, sizeof(rnd));
364                         new_idx = (i + rnd[i & 7]) % n_srates;
365
366                         while (SAMPLE_TBL(mi, new_idx, col) != 0)
367                                 new_idx = (new_idx + 1) % n_srates;
368
369                         /* Don't sample the slowest rate (i.e. slowest base
370                          * rate). We must presume that the slowest rate works
371                          * fine, or else other management frames will also be
372                          * failing and the link will break */
373                         SAMPLE_TBL(mi, new_idx, col) = i + 1;
374                 }
375         }
376 }
377
378 static void
379 minstrel_rate_init(void *priv, struct ieee80211_supported_band *sband,
380                struct ieee80211_sta *sta, void *priv_sta)
381 {
382         struct minstrel_sta_info *mi = priv_sta;
383         struct minstrel_priv *mp = priv;
384         struct ieee80211_rate *ctl_rate;
385         unsigned int i, n = 0;
386         unsigned int t_slot = 9; /* FIXME: get real slot time */
387
388         mi->lowest_rix = rate_lowest_index(sband, sta);
389         ctl_rate = &sband->bitrates[mi->lowest_rix];
390         mi->sp_ack_dur = ieee80211_frame_duration(sband->band, 10,
391                                 ctl_rate->bitrate,
392                                 !!(ctl_rate->flags & IEEE80211_RATE_ERP_G), 1);
393
394         for (i = 0; i < sband->n_bitrates; i++) {
395                 struct minstrel_rate *mr = &mi->r[n];
396                 unsigned int tx_time = 0, tx_time_cts = 0, tx_time_rtscts = 0;
397                 unsigned int tx_time_single;
398                 unsigned int cw = mp->cw_min;
399
400                 if (!rate_supported(sta, sband->band, i))
401                         continue;
402                 n++;
403                 memset(mr, 0, sizeof(*mr));
404
405                 mr->rix = i;
406                 mr->bitrate = sband->bitrates[i].bitrate / 5;
407                 calc_rate_durations(sband->band, mr, &sband->bitrates[i]);
408
409                 /* calculate maximum number of retransmissions before
410                  * fallback (based on maximum segment size) */
411                 mr->sample_limit = -1;
412                 mr->retry_count = 1;
413                 mr->retry_count_cts = 1;
414                 mr->retry_count_rtscts = 1;
415                 tx_time = mr->perfect_tx_time + mi->sp_ack_dur;
416                 do {
417                         /* add one retransmission */
418                         tx_time_single = mr->ack_time + mr->perfect_tx_time;
419
420                         /* contention window */
421                         tx_time_single += (t_slot * cw) >> 1;
422                         cw = min((cw << 1) | 1, mp->cw_max);
423
424                         tx_time += tx_time_single;
425                         tx_time_cts += tx_time_single + mi->sp_ack_dur;
426                         tx_time_rtscts += tx_time_single + 2 * mi->sp_ack_dur;
427                         if ((tx_time_cts < mp->segment_size) &&
428                                 (mr->retry_count_cts < mp->max_retry))
429                                 mr->retry_count_cts++;
430                         if ((tx_time_rtscts < mp->segment_size) &&
431                                 (mr->retry_count_rtscts < mp->max_retry))
432                                 mr->retry_count_rtscts++;
433                 } while ((tx_time < mp->segment_size) &&
434                                 (++mr->retry_count < mp->max_retry));
435                 mr->adjusted_retry_count = mr->retry_count;
436         }
437
438         for (i = n; i < sband->n_bitrates; i++) {
439                 struct minstrel_rate *mr = &mi->r[i];
440                 mr->rix = -1;
441         }
442
443         mi->n_rates = n;
444         mi->stats_update = jiffies;
445
446         init_sample_table(mi);
447 }
448
449 static void *
450 minstrel_alloc_sta(void *priv, struct ieee80211_sta *sta, gfp_t gfp)
451 {
452         struct ieee80211_supported_band *sband;
453         struct minstrel_sta_info *mi;
454         struct minstrel_priv *mp = priv;
455         struct ieee80211_hw *hw = mp->hw;
456         int max_rates = 0;
457         int i;
458
459         mi = kzalloc(sizeof(struct minstrel_sta_info), gfp);
460         if (!mi)
461                 return NULL;
462
463         for (i = 0; i < IEEE80211_NUM_BANDS; i++) {
464                 sband = hw->wiphy->bands[i];
465                 if (sband && sband->n_bitrates > max_rates)
466                         max_rates = sband->n_bitrates;
467         }
468
469         mi->r = kzalloc(sizeof(struct minstrel_rate) * max_rates, gfp);
470         if (!mi->r)
471                 goto error;
472
473         mi->sample_table = kmalloc(SAMPLE_COLUMNS * max_rates, gfp);
474         if (!mi->sample_table)
475                 goto error1;
476
477         mi->stats_update = jiffies;
478         return mi;
479
480 error1:
481         kfree(mi->r);
482 error:
483         kfree(mi);
484         return NULL;
485 }
486
487 static void
488 minstrel_free_sta(void *priv, struct ieee80211_sta *sta, void *priv_sta)
489 {
490         struct minstrel_sta_info *mi = priv_sta;
491
492         kfree(mi->sample_table);
493         kfree(mi->r);
494         kfree(mi);
495 }
496
497 static void
498 minstrel_init_cck_rates(struct minstrel_priv *mp)
499 {
500         static const int bitrates[4] = { 10, 20, 55, 110 };
501         struct ieee80211_supported_band *sband;
502         int i, j;
503
504         sband = mp->hw->wiphy->bands[IEEE80211_BAND_2GHZ];
505         if (!sband)
506                 return;
507
508         for (i = 0, j = 0; i < sband->n_bitrates; i++) {
509                 struct ieee80211_rate *rate = &sband->bitrates[i];
510
511                 if (rate->flags & IEEE80211_RATE_ERP_G)
512                         continue;
513
514                 for (j = 0; j < ARRAY_SIZE(bitrates); j++) {
515                         if (rate->bitrate != bitrates[j])
516                                 continue;
517
518                         mp->cck_rates[j] = i;
519                         break;
520                 }
521         }
522 }
523
524 static void *
525 minstrel_alloc(struct ieee80211_hw *hw, struct dentry *debugfsdir)
526 {
527         struct minstrel_priv *mp;
528
529         mp = kzalloc(sizeof(struct minstrel_priv), GFP_ATOMIC);
530         if (!mp)
531                 return NULL;
532
533         /* contention window settings
534          * Just an approximation. Using the per-queue values would complicate
535          * the calculations and is probably unnecessary */
536         mp->cw_min = 15;
537         mp->cw_max = 1023;
538
539         /* number of packets (in %) to use for sampling other rates
540          * sample less often for non-mrr packets, because the overhead
541          * is much higher than with mrr */
542         mp->lookaround_rate = 5;
543         mp->lookaround_rate_mrr = 10;
544
545         /* moving average weight for EWMA */
546         mp->ewma_level = 75;
547
548         /* maximum time that the hw is allowed to stay in one MRR segment */
549         mp->segment_size = 6000;
550
551         if (hw->max_rate_tries > 0)
552                 mp->max_retry = hw->max_rate_tries;
553         else
554                 /* safe default, does not necessarily have to match hw properties */
555                 mp->max_retry = 7;
556
557         if (hw->max_rates >= 4)
558                 mp->has_mrr = true;
559
560         mp->hw = hw;
561         mp->update_interval = 100;
562
563 #ifdef CONFIG_MAC80211_DEBUGFS
564         mp->fixed_rate_idx = (u32) -1;
565         mp->dbg_fixed_rate = debugfs_create_u32("fixed_rate_idx",
566                         S_IRUGO | S_IWUGO, debugfsdir, &mp->fixed_rate_idx);
567 #endif
568
569         minstrel_init_cck_rates(mp);
570
571         return mp;
572 }
573
574 static void
575 minstrel_free(void *priv)
576 {
577 #ifdef CONFIG_MAC80211_DEBUGFS
578         debugfs_remove(((struct minstrel_priv *)priv)->dbg_fixed_rate);
579 #endif
580         kfree(priv);
581 }
582
583 struct rate_control_ops mac80211_minstrel = {
584         .name = "minstrel",
585         .tx_status = minstrel_tx_status,
586         .get_rate = minstrel_get_rate,
587         .rate_init = minstrel_rate_init,
588         .alloc = minstrel_alloc,
589         .free = minstrel_free,
590         .alloc_sta = minstrel_alloc_sta,
591         .free_sta = minstrel_free_sta,
592 #ifdef CONFIG_MAC80211_DEBUGFS
593         .add_sta_debugfs = minstrel_add_sta_debugfs,
594         .remove_sta_debugfs = minstrel_remove_sta_debugfs,
595 #endif
596 };
597
598 int __init
599 rc80211_minstrel_init(void)
600 {
601         return ieee80211_rate_control_register(&mac80211_minstrel);
602 }
603
604 void
605 rc80211_minstrel_exit(void)
606 {
607         ieee80211_rate_control_unregister(&mac80211_minstrel);
608 }
609