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