]> err.no Git - linux-2.6/blob - net/mac80211/rc80211_pid_algo.c
mac80211: mesh data structures and first mesh changes
[linux-2.6] / net / mac80211 / rc80211_pid_algo.c
1 /*
2  * Copyright 2002-2005, Instant802 Networks, Inc.
3  * Copyright 2005, Devicescape Software, Inc.
4  * Copyright 2007, Mattias Nissler <mattias.nissler@gmx.de>
5  * Copyright 2007-2008, Stefano Brivio <stefano.brivio@polimi.it>
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License version 2 as
9  * published by the Free Software Foundation.
10  */
11
12 #include <linux/netdevice.h>
13 #include <linux/types.h>
14 #include <linux/skbuff.h>
15 #include <linux/debugfs.h>
16 #include <net/mac80211.h>
17 #include "ieee80211_rate.h"
18 #ifdef CONFIG_MAC80211_MESH
19 #include "mesh.h"
20 #endif
21
22 #include "rc80211_pid.h"
23
24
25 /* This is an implementation of a TX rate control algorithm that uses a PID
26  * controller. Given a target failed frames rate, the controller decides about
27  * TX rate changes to meet the target failed frames rate.
28  *
29  * The controller basically computes the following:
30  *
31  * adj = CP * err + CI * err_avg + CD * (err - last_err) * (1 + sharpening)
32  *
33  * where
34  *      adj     adjustment value that is used to switch TX rate (see below)
35  *      err     current error: target vs. current failed frames percentage
36  *      last_err        last error
37  *      err_avg average (i.e. poor man's integral) of recent errors
38  *      sharpening      non-zero when fast response is needed (i.e. right after
39  *                      association or no frames sent for a long time), heading
40  *                      to zero over time
41  *      CP      Proportional coefficient
42  *      CI      Integral coefficient
43  *      CD      Derivative coefficient
44  *
45  * CP, CI, CD are subject to careful tuning.
46  *
47  * The integral component uses a exponential moving average approach instead of
48  * an actual sliding window. The advantage is that we don't need to keep an
49  * array of the last N error values and computation is easier.
50  *
51  * Once we have the adj value, we map it to a rate by means of a learning
52  * algorithm. This algorithm keeps the state of the percentual failed frames
53  * difference between rates. The behaviour of the lowest available rate is kept
54  * as a reference value, and every time we switch between two rates, we compute
55  * the difference between the failed frames each rate exhibited. By doing so,
56  * we compare behaviours which different rates exhibited in adjacent timeslices,
57  * thus the comparison is minimally affected by external conditions. This
58  * difference gets propagated to the whole set of measurements, so that the
59  * reference is always the same. Periodically, we normalize this set so that
60  * recent events weigh the most. By comparing the adj value with this set, we
61  * avoid pejorative switches to lower rates and allow for switches to higher
62  * rates if they behaved well.
63  *
64  * Note that for the computations we use a fixed-point representation to avoid
65  * floating point arithmetic. Hence, all values are shifted left by
66  * RC_PID_ARITH_SHIFT.
67  */
68
69
70 /* Adjust the rate while ensuring that we won't switch to a lower rate if it
71  * exhibited a worse failed frames behaviour and we'll choose the highest rate
72  * whose failed frames behaviour is not worse than the one of the original rate
73  * target. While at it, check that the new rate is valid. */
74 static void rate_control_pid_adjust_rate(struct ieee80211_local *local,
75                                          struct sta_info *sta, int adj,
76                                          struct rc_pid_rateinfo *rinfo)
77 {
78         struct ieee80211_sub_if_data *sdata;
79         struct ieee80211_supported_band *sband;
80         int cur_sorted, new_sorted, probe, tmp, n_bitrates, band;
81         int cur = sta->txrate_idx;
82
83         sdata = IEEE80211_DEV_TO_SUB_IF(sta->dev);
84         sband = local->hw.wiphy->bands[local->hw.conf.channel->band];
85         band = sband->band;
86         n_bitrates = sband->n_bitrates;
87
88         /* Map passed arguments to sorted values. */
89         cur_sorted = rinfo[cur].rev_index;
90         new_sorted = cur_sorted + adj;
91
92         /* Check limits. */
93         if (new_sorted < 0)
94                 new_sorted = rinfo[0].rev_index;
95         else if (new_sorted >= n_bitrates)
96                 new_sorted = rinfo[n_bitrates - 1].rev_index;
97
98         tmp = new_sorted;
99
100         if (adj < 0) {
101                 /* Ensure that the rate decrease isn't disadvantageous. */
102                 for (probe = cur_sorted; probe >= new_sorted; probe--)
103                         if (rinfo[probe].diff <= rinfo[cur_sorted].diff &&
104                             rate_supported(sta, band, rinfo[probe].index))
105                                 tmp = probe;
106         } else {
107                 /* Look for rate increase with zero (or below) cost. */
108                 for (probe = new_sorted + 1; probe < n_bitrates; probe++)
109                         if (rinfo[probe].diff <= rinfo[new_sorted].diff &&
110                             rate_supported(sta, band, rinfo[probe].index))
111                                 tmp = probe;
112         }
113
114         /* Fit the rate found to the nearest supported rate. */
115         do {
116                 if (rate_supported(sta, band, rinfo[tmp].index)) {
117                         sta->txrate_idx = rinfo[tmp].index;
118                         break;
119                 }
120                 if (adj < 0)
121                         tmp--;
122                 else
123                         tmp++;
124         } while (tmp < n_bitrates && tmp >= 0);
125
126 #ifdef CONFIG_MAC80211_DEBUGFS
127         rate_control_pid_event_rate_change(
128                 &((struct rc_pid_sta_info *)sta->rate_ctrl_priv)->events,
129                 sta->txrate_idx, sband->bitrates[sta->txrate_idx].bitrate);
130 #endif
131 }
132
133 /* Normalize the failed frames per-rate differences. */
134 static void rate_control_pid_normalize(struct rc_pid_info *pinfo, int l)
135 {
136         int i, norm_offset = pinfo->norm_offset;
137         struct rc_pid_rateinfo *r = pinfo->rinfo;
138
139         if (r[0].diff > norm_offset)
140                 r[0].diff -= norm_offset;
141         else if (r[0].diff < -norm_offset)
142                 r[0].diff += norm_offset;
143         for (i = 0; i < l - 1; i++)
144                 if (r[i + 1].diff > r[i].diff + norm_offset)
145                         r[i + 1].diff -= norm_offset;
146                 else if (r[i + 1].diff <= r[i].diff)
147                         r[i + 1].diff += norm_offset;
148 }
149
150 static void rate_control_pid_sample(struct rc_pid_info *pinfo,
151                                     struct ieee80211_local *local,
152                                     struct sta_info *sta)
153 {
154 #ifdef CONFIG_MAC80211_MESH
155         struct ieee80211_sub_if_data *sdata = IEEE80211_DEV_TO_SUB_IF(sta->dev);
156 #endif
157         struct rc_pid_sta_info *spinfo = sta->rate_ctrl_priv;
158         struct rc_pid_rateinfo *rinfo = pinfo->rinfo;
159         struct ieee80211_supported_band *sband;
160         u32 pf;
161         s32 err_avg;
162         u32 err_prop;
163         u32 err_int;
164         u32 err_der;
165         int adj, i, j, tmp;
166         unsigned long period;
167
168         sband = local->hw.wiphy->bands[local->hw.conf.channel->band];
169         spinfo = sta->rate_ctrl_priv;
170
171         /* In case nothing happened during the previous control interval, turn
172          * the sharpening factor on. */
173         period = (HZ * pinfo->sampling_period + 500) / 1000;
174         if (!period)
175                 period = 1;
176         if (jiffies - spinfo->last_sample > 2 * period)
177                 spinfo->sharp_cnt = pinfo->sharpen_duration;
178
179         spinfo->last_sample = jiffies;
180
181         /* This should never happen, but in case, we assume the old sample is
182          * still a good measurement and copy it. */
183         if (unlikely(spinfo->tx_num_xmit == 0))
184                 pf = spinfo->last_pf;
185         else {
186                 pf = spinfo->tx_num_failed * 100 / spinfo->tx_num_xmit;
187 #ifdef CONFIG_MAC80211_MESH
188                 if (pf == 100 &&
189                     sdata->vif.type == IEEE80211_IF_TYPE_MESH_POINT)
190                         mesh_plink_broken(sta);
191 #endif
192                 pf <<= RC_PID_ARITH_SHIFT;
193                 sta->fail_avg = ((pf + (spinfo->last_pf << 3)) / 9)
194                                         >> RC_PID_ARITH_SHIFT;
195         }
196
197         spinfo->tx_num_xmit = 0;
198         spinfo->tx_num_failed = 0;
199
200         /* If we just switched rate, update the rate behaviour info. */
201         if (pinfo->oldrate != sta->txrate_idx) {
202
203                 i = rinfo[pinfo->oldrate].rev_index;
204                 j = rinfo[sta->txrate_idx].rev_index;
205
206                 tmp = (pf - spinfo->last_pf);
207                 tmp = RC_PID_DO_ARITH_RIGHT_SHIFT(tmp, RC_PID_ARITH_SHIFT);
208
209                 rinfo[j].diff = rinfo[i].diff + tmp;
210                 pinfo->oldrate = sta->txrate_idx;
211         }
212         rate_control_pid_normalize(pinfo, sband->n_bitrates);
213
214         /* Compute the proportional, integral and derivative errors. */
215         err_prop = (pinfo->target << RC_PID_ARITH_SHIFT) - pf;
216
217         err_avg = spinfo->err_avg_sc >> pinfo->smoothing_shift;
218         spinfo->err_avg_sc = spinfo->err_avg_sc - err_avg + err_prop;
219         err_int = spinfo->err_avg_sc >> pinfo->smoothing_shift;
220
221         err_der = (pf - spinfo->last_pf) *
222                   (1 + pinfo->sharpen_factor * spinfo->sharp_cnt);
223         spinfo->last_pf = pf;
224         if (spinfo->sharp_cnt)
225                         spinfo->sharp_cnt--;
226
227 #ifdef CONFIG_MAC80211_DEBUGFS
228         rate_control_pid_event_pf_sample(&spinfo->events, pf, err_prop, err_int,
229                                          err_der);
230 #endif
231
232         /* Compute the controller output. */
233         adj = (err_prop * pinfo->coeff_p + err_int * pinfo->coeff_i
234               + err_der * pinfo->coeff_d);
235         adj = RC_PID_DO_ARITH_RIGHT_SHIFT(adj, 2 * RC_PID_ARITH_SHIFT);
236
237         /* Change rate. */
238         if (adj)
239                 rate_control_pid_adjust_rate(local, sta, adj, rinfo);
240 }
241
242 static void rate_control_pid_tx_status(void *priv, struct net_device *dev,
243                                        struct sk_buff *skb,
244                                        struct ieee80211_tx_status *status)
245 {
246         struct ieee80211_local *local = wdev_priv(dev->ieee80211_ptr);
247         struct ieee80211_hdr *hdr = (struct ieee80211_hdr *) skb->data;
248         struct ieee80211_sub_if_data *sdata;
249         struct rc_pid_info *pinfo = priv;
250         struct sta_info *sta;
251         struct rc_pid_sta_info *spinfo;
252         unsigned long period;
253         struct ieee80211_supported_band *sband;
254
255         sta = sta_info_get(local, hdr->addr1);
256         sband = local->hw.wiphy->bands[local->hw.conf.channel->band];
257
258         if (!sta)
259                 return;
260
261         /* Don't update the state if we're not controlling the rate. */
262         sdata = IEEE80211_DEV_TO_SUB_IF(sta->dev);
263         if (sdata->bss && sdata->bss->force_unicast_rateidx > -1) {
264                 sta->txrate_idx = sdata->bss->max_ratectrl_rateidx;
265                 return;
266         }
267
268         /* Ignore all frames that were sent with a different rate than the rate
269          * we currently advise mac80211 to use. */
270         if (status->control.tx_rate != &sband->bitrates[sta->txrate_idx])
271                 goto ignore;
272
273         spinfo = sta->rate_ctrl_priv;
274         spinfo->tx_num_xmit++;
275
276 #ifdef CONFIG_MAC80211_DEBUGFS
277         rate_control_pid_event_tx_status(&spinfo->events, status);
278 #endif
279
280         /* We count frames that totally failed to be transmitted as two bad
281          * frames, those that made it out but had some retries as one good and
282          * one bad frame. */
283         if (status->excessive_retries) {
284                 spinfo->tx_num_failed += 2;
285                 spinfo->tx_num_xmit++;
286         } else if (status->retry_count) {
287                 spinfo->tx_num_failed++;
288                 spinfo->tx_num_xmit++;
289         }
290
291         if (status->excessive_retries) {
292                 sta->tx_retry_failed++;
293                 sta->tx_num_consecutive_failures++;
294                 sta->tx_num_mpdu_fail++;
295         } else {
296                 sta->tx_num_consecutive_failures = 0;
297                 sta->tx_num_mpdu_ok++;
298         }
299         sta->tx_retry_count += status->retry_count;
300         sta->tx_num_mpdu_fail += status->retry_count;
301
302         /* Update PID controller state. */
303         period = (HZ * pinfo->sampling_period + 500) / 1000;
304         if (!period)
305                 period = 1;
306         if (time_after(jiffies, spinfo->last_sample + period))
307                 rate_control_pid_sample(pinfo, local, sta);
308
309 ignore:
310         sta_info_put(sta);
311 }
312
313 static void rate_control_pid_get_rate(void *priv, struct net_device *dev,
314                                       struct ieee80211_supported_band *sband,
315                                       struct sk_buff *skb,
316                                       struct rate_selection *sel)
317 {
318         struct ieee80211_local *local = wdev_priv(dev->ieee80211_ptr);
319         struct ieee80211_hdr *hdr = (struct ieee80211_hdr *) skb->data;
320         struct ieee80211_sub_if_data *sdata;
321         struct sta_info *sta;
322         int rateidx;
323         u16 fc;
324
325         sta = sta_info_get(local, hdr->addr1);
326
327         /* Send management frames and broadcast/multicast data using lowest
328          * rate. */
329         fc = le16_to_cpu(hdr->frame_control);
330         if ((fc & IEEE80211_FCTL_FTYPE) != IEEE80211_FTYPE_DATA ||
331             is_multicast_ether_addr(hdr->addr1) || !sta) {
332                 sel->rate = rate_lowest(local, sband, sta);
333                 if (sta)
334                         sta_info_put(sta);
335                 return;
336         }
337
338         /* If a forced rate is in effect, select it. */
339         sdata = IEEE80211_DEV_TO_SUB_IF(dev);
340         if (sdata->bss && sdata->bss->force_unicast_rateidx > -1)
341                 sta->txrate_idx = sdata->bss->force_unicast_rateidx;
342
343         rateidx = sta->txrate_idx;
344
345         if (rateidx >= sband->n_bitrates)
346                 rateidx = sband->n_bitrates - 1;
347
348         sta->last_txrate_idx = rateidx;
349
350         sta_info_put(sta);
351
352         sel->rate = &sband->bitrates[rateidx];
353
354 #ifdef CONFIG_MAC80211_DEBUGFS
355         rate_control_pid_event_tx_rate(
356                 &((struct rc_pid_sta_info *) sta->rate_ctrl_priv)->events,
357                 rateidx, sband->bitrates[rateidx].bitrate);
358 #endif
359 }
360
361 static void rate_control_pid_rate_init(void *priv, void *priv_sta,
362                                           struct ieee80211_local *local,
363                                           struct sta_info *sta)
364 {
365         /* TODO: This routine should consider using RSSI from previous packets
366          * as we need to have IEEE 802.1X auth succeed immediately after assoc..
367          * Until that method is implemented, we will use the lowest supported
368          * rate as a workaround. */
369         struct ieee80211_supported_band *sband;
370
371         sband = local->hw.wiphy->bands[local->hw.conf.channel->band];
372         sta->txrate_idx = rate_lowest_index(local, sband, sta);
373         sta->fail_avg = 0;
374 }
375
376 static void *rate_control_pid_alloc(struct ieee80211_local *local)
377 {
378         struct rc_pid_info *pinfo;
379         struct rc_pid_rateinfo *rinfo;
380         struct ieee80211_supported_band *sband;
381         int i, j, tmp;
382         bool s;
383 #ifdef CONFIG_MAC80211_DEBUGFS
384         struct rc_pid_debugfs_entries *de;
385 #endif
386
387         sband = local->hw.wiphy->bands[local->hw.conf.channel->band];
388
389         pinfo = kmalloc(sizeof(*pinfo), GFP_ATOMIC);
390         if (!pinfo)
391                 return NULL;
392
393         /* We can safely assume that sband won't change unless we get
394          * reinitialized. */
395         rinfo = kmalloc(sizeof(*rinfo) * sband->n_bitrates, GFP_ATOMIC);
396         if (!rinfo) {
397                 kfree(pinfo);
398                 return NULL;
399         }
400
401         /* Sort the rates. This is optimized for the most common case (i.e.
402          * almost-sorted CCK+OFDM rates). Kind of bubble-sort with reversed
403          * mapping too. */
404         for (i = 0; i < sband->n_bitrates; i++) {
405                 rinfo[i].index = i;
406                 rinfo[i].rev_index = i;
407                 if (pinfo->fast_start)
408                         rinfo[i].diff = 0;
409                 else
410                         rinfo[i].diff = i * pinfo->norm_offset;
411         }
412         for (i = 1; i < sband->n_bitrates; i++) {
413                 s = 0;
414                 for (j = 0; j < sband->n_bitrates - i; j++)
415                         if (unlikely(sband->bitrates[rinfo[j].index].bitrate >
416                                      sband->bitrates[rinfo[j + 1].index].bitrate)) {
417                                 tmp = rinfo[j].index;
418                                 rinfo[j].index = rinfo[j + 1].index;
419                                 rinfo[j + 1].index = tmp;
420                                 rinfo[rinfo[j].index].rev_index = j;
421                                 rinfo[rinfo[j + 1].index].rev_index = j + 1;
422                                 s = 1;
423                         }
424                 if (!s)
425                         break;
426         }
427
428         pinfo->target = RC_PID_TARGET_PF;
429         pinfo->sampling_period = RC_PID_INTERVAL;
430         pinfo->coeff_p = RC_PID_COEFF_P;
431         pinfo->coeff_i = RC_PID_COEFF_I;
432         pinfo->coeff_d = RC_PID_COEFF_D;
433         pinfo->smoothing_shift = RC_PID_SMOOTHING_SHIFT;
434         pinfo->sharpen_factor = RC_PID_SHARPENING_FACTOR;
435         pinfo->sharpen_duration = RC_PID_SHARPENING_DURATION;
436         pinfo->norm_offset = RC_PID_NORM_OFFSET;
437         pinfo->fast_start = RC_PID_FAST_START;
438         pinfo->rinfo = rinfo;
439         pinfo->oldrate = 0;
440
441 #ifdef CONFIG_MAC80211_DEBUGFS
442         de = &pinfo->dentries;
443         de->dir = debugfs_create_dir("rc80211_pid",
444                                      local->hw.wiphy->debugfsdir);
445         de->target = debugfs_create_u32("target_pf", S_IRUSR | S_IWUSR,
446                                         de->dir, &pinfo->target);
447         de->sampling_period = debugfs_create_u32("sampling_period",
448                                                  S_IRUSR | S_IWUSR, de->dir,
449                                                  &pinfo->sampling_period);
450         de->coeff_p = debugfs_create_u32("coeff_p", S_IRUSR | S_IWUSR,
451                                          de->dir, &pinfo->coeff_p);
452         de->coeff_i = debugfs_create_u32("coeff_i", S_IRUSR | S_IWUSR,
453                                          de->dir, &pinfo->coeff_i);
454         de->coeff_d = debugfs_create_u32("coeff_d", S_IRUSR | S_IWUSR,
455                                          de->dir, &pinfo->coeff_d);
456         de->smoothing_shift = debugfs_create_u32("smoothing_shift",
457                                                  S_IRUSR | S_IWUSR, de->dir,
458                                                  &pinfo->smoothing_shift);
459         de->sharpen_factor = debugfs_create_u32("sharpen_factor",
460                                                S_IRUSR | S_IWUSR, de->dir,
461                                                &pinfo->sharpen_factor);
462         de->sharpen_duration = debugfs_create_u32("sharpen_duration",
463                                                   S_IRUSR | S_IWUSR, de->dir,
464                                                   &pinfo->sharpen_duration);
465         de->norm_offset = debugfs_create_u32("norm_offset",
466                                              S_IRUSR | S_IWUSR, de->dir,
467                                              &pinfo->norm_offset);
468         de->fast_start = debugfs_create_bool("fast_start",
469                                              S_IRUSR | S_IWUSR, de->dir,
470                                              &pinfo->fast_start);
471 #endif
472
473         return pinfo;
474 }
475
476 static void rate_control_pid_free(void *priv)
477 {
478         struct rc_pid_info *pinfo = priv;
479 #ifdef CONFIG_MAC80211_DEBUGFS
480         struct rc_pid_debugfs_entries *de = &pinfo->dentries;
481
482         debugfs_remove(de->fast_start);
483         debugfs_remove(de->norm_offset);
484         debugfs_remove(de->sharpen_duration);
485         debugfs_remove(de->sharpen_factor);
486         debugfs_remove(de->smoothing_shift);
487         debugfs_remove(de->coeff_d);
488         debugfs_remove(de->coeff_i);
489         debugfs_remove(de->coeff_p);
490         debugfs_remove(de->sampling_period);
491         debugfs_remove(de->target);
492         debugfs_remove(de->dir);
493 #endif
494
495         kfree(pinfo->rinfo);
496         kfree(pinfo);
497 }
498
499 static void rate_control_pid_clear(void *priv)
500 {
501 }
502
503 static void *rate_control_pid_alloc_sta(void *priv, gfp_t gfp)
504 {
505         struct rc_pid_sta_info *spinfo;
506
507         spinfo = kzalloc(sizeof(*spinfo), gfp);
508         if (spinfo == NULL)
509                 return NULL;
510
511         spinfo->last_sample = jiffies;
512
513 #ifdef CONFIG_MAC80211_DEBUGFS
514         spin_lock_init(&spinfo->events.lock);
515         init_waitqueue_head(&spinfo->events.waitqueue);
516 #endif
517
518         return spinfo;
519 }
520
521 static void rate_control_pid_free_sta(void *priv, void *priv_sta)
522 {
523         struct rc_pid_sta_info *spinfo = priv_sta;
524         kfree(spinfo);
525 }
526
527 static struct rate_control_ops mac80211_rcpid = {
528         .name = "pid",
529         .tx_status = rate_control_pid_tx_status,
530         .get_rate = rate_control_pid_get_rate,
531         .rate_init = rate_control_pid_rate_init,
532         .clear = rate_control_pid_clear,
533         .alloc = rate_control_pid_alloc,
534         .free = rate_control_pid_free,
535         .alloc_sta = rate_control_pid_alloc_sta,
536         .free_sta = rate_control_pid_free_sta,
537 #ifdef CONFIG_MAC80211_DEBUGFS
538         .add_sta_debugfs = rate_control_pid_add_sta_debugfs,
539         .remove_sta_debugfs = rate_control_pid_remove_sta_debugfs,
540 #endif
541 };
542
543 MODULE_DESCRIPTION("PID controller based rate control algorithm");
544 MODULE_AUTHOR("Stefano Brivio");
545 MODULE_AUTHOR("Mattias Nissler");
546 MODULE_LICENSE("GPL");
547
548 int __init rc80211_pid_init(void)
549 {
550         return ieee80211_rate_control_register(&mac80211_rcpid);
551 }
552
553 void rc80211_pid_exit(void)
554 {
555         ieee80211_rate_control_unregister(&mac80211_rcpid);
556 }
557
558 #ifdef CONFIG_MAC80211_RC_PID_MODULE
559 module_init(rc80211_pid_init);
560 module_exit(rc80211_pid_exit);
561 #endif