Merge branch 'master' of git://git.kernel.org/pub/scm/linux/kernel/git/linville/wirel...
[linux-2.6.git] / 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 "rate.h"
18 #include "mesh.h"
19 #include "rc80211_pid.h"
20
21
22 /* This is an implementation of a TX rate control algorithm that uses a PID
23  * controller. Given a target failed frames rate, the controller decides about
24  * TX rate changes to meet the target failed frames rate.
25  *
26  * The controller basically computes the following:
27  *
28  * adj = CP * err + CI * err_avg + CD * (err - last_err) * (1 + sharpening)
29  *
30  * where
31  *      adj     adjustment value that is used to switch TX rate (see below)
32  *      err     current error: target vs. current failed frames percentage
33  *      last_err        last error
34  *      err_avg average (i.e. poor man's integral) of recent errors
35  *      sharpening      non-zero when fast response is needed (i.e. right after
36  *                      association or no frames sent for a long time), heading
37  *                      to zero over time
38  *      CP      Proportional coefficient
39  *      CI      Integral coefficient
40  *      CD      Derivative coefficient
41  *
42  * CP, CI, CD are subject to careful tuning.
43  *
44  * The integral component uses a exponential moving average approach instead of
45  * an actual sliding window. The advantage is that we don't need to keep an
46  * array of the last N error values and computation is easier.
47  *
48  * Once we have the adj value, we map it to a rate by means of a learning
49  * algorithm. This algorithm keeps the state of the percentual failed frames
50  * difference between rates. The behaviour of the lowest available rate is kept
51  * as a reference value, and every time we switch between two rates, we compute
52  * the difference between the failed frames each rate exhibited. By doing so,
53  * we compare behaviours which different rates exhibited in adjacent timeslices,
54  * thus the comparison is minimally affected by external conditions. This
55  * difference gets propagated to the whole set of measurements, so that the
56  * reference is always the same. Periodically, we normalize this set so that
57  * recent events weigh the most. By comparing the adj value with this set, we
58  * avoid pejorative switches to lower rates and allow for switches to higher
59  * rates if they behaved well.
60  *
61  * Note that for the computations we use a fixed-point representation to avoid
62  * floating point arithmetic. Hence, all values are shifted left by
63  * RC_PID_ARITH_SHIFT.
64  */
65
66
67 /* Adjust the rate while ensuring that we won't switch to a lower rate if it
68  * exhibited a worse failed frames behaviour and we'll choose the highest rate
69  * whose failed frames behaviour is not worse than the one of the original rate
70  * target. While at it, check that the new rate is valid. */
71 static void rate_control_pid_adjust_rate(struct ieee80211_supported_band *sband,
72                                          struct ieee80211_sta *sta,
73                                          struct rc_pid_sta_info *spinfo, int adj,
74                                          struct rc_pid_rateinfo *rinfo)
75 {
76         int cur_sorted, new_sorted, probe, tmp, n_bitrates, band;
77         int cur = spinfo->txrate_idx;
78
79         band = sband->band;
80         n_bitrates = sband->n_bitrates;
81
82         /* Map passed arguments to sorted values. */
83         cur_sorted = rinfo[cur].rev_index;
84         new_sorted = cur_sorted + adj;
85
86         /* Check limits. */
87         if (new_sorted < 0)
88                 new_sorted = rinfo[0].rev_index;
89         else if (new_sorted >= n_bitrates)
90                 new_sorted = rinfo[n_bitrates - 1].rev_index;
91
92         tmp = new_sorted;
93
94         if (adj < 0) {
95                 /* Ensure that the rate decrease isn't disadvantageous. */
96                 for (probe = cur_sorted; probe >= new_sorted; probe--)
97                         if (rinfo[probe].diff <= rinfo[cur_sorted].diff &&
98                             rate_supported(sta, band, rinfo[probe].index))
99                                 tmp = probe;
100         } else {
101                 /* Look for rate increase with zero (or below) cost. */
102                 for (probe = new_sorted + 1; probe < n_bitrates; probe++)
103                         if (rinfo[probe].diff <= rinfo[new_sorted].diff &&
104                             rate_supported(sta, band, rinfo[probe].index))
105                                 tmp = probe;
106         }
107
108         /* Fit the rate found to the nearest supported rate. */
109         do {
110                 if (rate_supported(sta, band, rinfo[tmp].index)) {
111                         spinfo->txrate_idx = rinfo[tmp].index;
112                         break;
113                 }
114                 if (adj < 0)
115                         tmp--;
116                 else
117                         tmp++;
118         } while (tmp < n_bitrates && tmp >= 0);
119
120 #ifdef CONFIG_MAC80211_DEBUGFS
121         rate_control_pid_event_rate_change(&spinfo->events,
122                 spinfo->txrate_idx,
123                 sband->bitrates[spinfo->txrate_idx].bitrate);
124 #endif
125 }
126
127 /* Normalize the failed frames per-rate differences. */
128 static void rate_control_pid_normalize(struct rc_pid_info *pinfo, int l)
129 {
130         int i, norm_offset = pinfo->norm_offset;
131         struct rc_pid_rateinfo *r = pinfo->rinfo;
132
133         if (r[0].diff > norm_offset)
134                 r[0].diff -= norm_offset;
135         else if (r[0].diff < -norm_offset)
136                 r[0].diff += norm_offset;
137         for (i = 0; i < l - 1; i++)
138                 if (r[i + 1].diff > r[i].diff + norm_offset)
139                         r[i + 1].diff -= norm_offset;
140                 else if (r[i + 1].diff <= r[i].diff)
141                         r[i + 1].diff += norm_offset;
142 }
143
144 static void rate_control_pid_sample(struct rc_pid_info *pinfo,
145                                     struct ieee80211_supported_band *sband,
146                                     struct ieee80211_sta *sta,
147                                     struct rc_pid_sta_info *spinfo)
148 {
149         struct rc_pid_rateinfo *rinfo = pinfo->rinfo;
150         u32 pf;
151         s32 err_avg;
152         u32 err_prop;
153         u32 err_int;
154         u32 err_der;
155         int adj, i, j, tmp;
156         unsigned long period;
157
158         /* In case nothing happened during the previous control interval, turn
159          * the sharpening factor on. */
160         period = msecs_to_jiffies(pinfo->sampling_period);
161         if (jiffies - spinfo->last_sample > 2 * period)
162                 spinfo->sharp_cnt = pinfo->sharpen_duration;
163
164         spinfo->last_sample = jiffies;
165
166         /* This should never happen, but in case, we assume the old sample is
167          * still a good measurement and copy it. */
168         if (unlikely(spinfo->tx_num_xmit == 0))
169                 pf = spinfo->last_pf;
170         else
171                 pf = spinfo->tx_num_failed * 100 / spinfo->tx_num_xmit;
172
173         spinfo->tx_num_xmit = 0;
174         spinfo->tx_num_failed = 0;
175
176         /* If we just switched rate, update the rate behaviour info. */
177         if (pinfo->oldrate != spinfo->txrate_idx) {
178
179                 i = rinfo[pinfo->oldrate].rev_index;
180                 j = rinfo[spinfo->txrate_idx].rev_index;
181
182                 tmp = (pf - spinfo->last_pf);
183                 tmp = RC_PID_DO_ARITH_RIGHT_SHIFT(tmp, RC_PID_ARITH_SHIFT);
184
185                 rinfo[j].diff = rinfo[i].diff + tmp;
186                 pinfo->oldrate = spinfo->txrate_idx;
187         }
188         rate_control_pid_normalize(pinfo, sband->n_bitrates);
189
190         /* Compute the proportional, integral and derivative errors. */
191         err_prop = (pinfo->target - pf) << RC_PID_ARITH_SHIFT;
192
193         err_avg = spinfo->err_avg_sc >> pinfo->smoothing_shift;
194         spinfo->err_avg_sc = spinfo->err_avg_sc - err_avg + err_prop;
195         err_int = spinfo->err_avg_sc >> pinfo->smoothing_shift;
196
197         err_der = (pf - spinfo->last_pf) *
198                   (1 + pinfo->sharpen_factor * spinfo->sharp_cnt);
199         spinfo->last_pf = pf;
200         if (spinfo->sharp_cnt)
201                         spinfo->sharp_cnt--;
202
203 #ifdef CONFIG_MAC80211_DEBUGFS
204         rate_control_pid_event_pf_sample(&spinfo->events, pf, err_prop, err_int,
205                                          err_der);
206 #endif
207
208         /* Compute the controller output. */
209         adj = (err_prop * pinfo->coeff_p + err_int * pinfo->coeff_i
210               + err_der * pinfo->coeff_d);
211         adj = RC_PID_DO_ARITH_RIGHT_SHIFT(adj, 2 * RC_PID_ARITH_SHIFT);
212
213         /* Change rate. */
214         if (adj)
215                 rate_control_pid_adjust_rate(sband, sta, spinfo, adj, rinfo);
216 }
217
218 static void rate_control_pid_tx_status(void *priv, struct ieee80211_supported_band *sband,
219                                        struct ieee80211_sta *sta, void *priv_sta,
220                                        struct sk_buff *skb)
221 {
222         struct rc_pid_info *pinfo = priv;
223         struct rc_pid_sta_info *spinfo = priv_sta;
224         unsigned long period;
225         struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
226
227         if (!spinfo)
228                 return;
229
230         /* Ignore all frames that were sent with a different rate than the rate
231          * we currently advise mac80211 to use. */
232         if (info->status.rates[0].idx != spinfo->txrate_idx)
233                 return;
234
235         spinfo->tx_num_xmit++;
236
237 #ifdef CONFIG_MAC80211_DEBUGFS
238         rate_control_pid_event_tx_status(&spinfo->events, info);
239 #endif
240
241         /* We count frames that totally failed to be transmitted as two bad
242          * frames, those that made it out but had some retries as one good and
243          * one bad frame. */
244         if (!(info->flags & IEEE80211_TX_STAT_ACK)) {
245                 spinfo->tx_num_failed += 2;
246                 spinfo->tx_num_xmit++;
247         } else if (info->status.rates[0].count > 1) {
248                 spinfo->tx_num_failed++;
249                 spinfo->tx_num_xmit++;
250         }
251
252         /* Update PID controller state. */
253         period = msecs_to_jiffies(pinfo->sampling_period);
254         if (time_after(jiffies, spinfo->last_sample + period))
255                 rate_control_pid_sample(pinfo, sband, sta, spinfo);
256 }
257
258 static void
259 rate_control_pid_get_rate(void *priv, struct ieee80211_sta *sta,
260                           void *priv_sta,
261                           struct ieee80211_tx_rate_control *txrc)
262 {
263         struct sk_buff *skb = txrc->skb;
264         struct ieee80211_supported_band *sband = txrc->sband;
265         struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
266         struct rc_pid_sta_info *spinfo = priv_sta;
267         int rateidx;
268
269         if (txrc->rts)
270                 info->control.rates[0].count =
271                         txrc->hw->conf.long_frame_max_tx_count;
272         else
273                 info->control.rates[0].count =
274                         txrc->hw->conf.short_frame_max_tx_count;
275
276         /* Send management frames and NO_ACK data using lowest rate. */
277         if (rate_control_send_low(sta, priv_sta, txrc))
278                 return;
279
280         rateidx = spinfo->txrate_idx;
281
282         if (rateidx >= sband->n_bitrates)
283                 rateidx = sband->n_bitrates - 1;
284
285         info->control.rates[0].idx = rateidx;
286
287 #ifdef CONFIG_MAC80211_DEBUGFS
288         rate_control_pid_event_tx_rate(&spinfo->events,
289                 rateidx, sband->bitrates[rateidx].bitrate);
290 #endif
291 }
292
293 static void
294 rate_control_pid_rate_init(void *priv, struct ieee80211_supported_band *sband,
295                            struct ieee80211_sta *sta, void *priv_sta)
296 {
297         struct rc_pid_sta_info *spinfo = priv_sta;
298         struct rc_pid_info *pinfo = priv;
299         struct rc_pid_rateinfo *rinfo = pinfo->rinfo;
300         int i, j, tmp;
301         bool s;
302
303         /* TODO: This routine should consider using RSSI from previous packets
304          * as we need to have IEEE 802.1X auth succeed immediately after assoc..
305          * Until that method is implemented, we will use the lowest supported
306          * rate as a workaround. */
307
308         /* Sort the rates. This is optimized for the most common case (i.e.
309          * almost-sorted CCK+OFDM rates). Kind of bubble-sort with reversed
310          * mapping too. */
311         for (i = 0; i < sband->n_bitrates; i++) {
312                 rinfo[i].index = i;
313                 rinfo[i].rev_index = i;
314                 if (RC_PID_FAST_START)
315                         rinfo[i].diff = 0;
316                 else
317                         rinfo[i].diff = i * pinfo->norm_offset;
318         }
319         for (i = 1; i < sband->n_bitrates; i++) {
320                 s = 0;
321                 for (j = 0; j < sband->n_bitrates - i; j++)
322                         if (unlikely(sband->bitrates[rinfo[j].index].bitrate >
323                                      sband->bitrates[rinfo[j + 1].index].bitrate)) {
324                                 tmp = rinfo[j].index;
325                                 rinfo[j].index = rinfo[j + 1].index;
326                                 rinfo[j + 1].index = tmp;
327                                 rinfo[rinfo[j].index].rev_index = j;
328                                 rinfo[rinfo[j + 1].index].rev_index = j + 1;
329                                 s = 1;
330                         }
331                 if (!s)
332                         break;
333         }
334
335         spinfo->txrate_idx = rate_lowest_index(sband, sta);
336 }
337
338 static void *rate_control_pid_alloc(struct ieee80211_hw *hw,
339                                     struct dentry *debugfsdir)
340 {
341         struct rc_pid_info *pinfo;
342         struct rc_pid_rateinfo *rinfo;
343         struct ieee80211_supported_band *sband;
344         int i, max_rates = 0;
345 #ifdef CONFIG_MAC80211_DEBUGFS
346         struct rc_pid_debugfs_entries *de;
347 #endif
348
349         pinfo = kmalloc(sizeof(*pinfo), GFP_ATOMIC);
350         if (!pinfo)
351                 return NULL;
352
353         for (i = 0; i < IEEE80211_NUM_BANDS; i++) {
354                 sband = hw->wiphy->bands[i];
355                 if (sband && sband->n_bitrates > max_rates)
356                         max_rates = sband->n_bitrates;
357         }
358
359         rinfo = kmalloc(sizeof(*rinfo) * max_rates, GFP_ATOMIC);
360         if (!rinfo) {
361                 kfree(pinfo);
362                 return NULL;
363         }
364
365         pinfo->target = RC_PID_TARGET_PF;
366         pinfo->sampling_period = RC_PID_INTERVAL;
367         pinfo->coeff_p = RC_PID_COEFF_P;
368         pinfo->coeff_i = RC_PID_COEFF_I;
369         pinfo->coeff_d = RC_PID_COEFF_D;
370         pinfo->smoothing_shift = RC_PID_SMOOTHING_SHIFT;
371         pinfo->sharpen_factor = RC_PID_SHARPENING_FACTOR;
372         pinfo->sharpen_duration = RC_PID_SHARPENING_DURATION;
373         pinfo->norm_offset = RC_PID_NORM_OFFSET;
374         pinfo->rinfo = rinfo;
375         pinfo->oldrate = 0;
376
377 #ifdef CONFIG_MAC80211_DEBUGFS
378         de = &pinfo->dentries;
379         de->target = debugfs_create_u32("target_pf", S_IRUSR | S_IWUSR,
380                                         debugfsdir, &pinfo->target);
381         de->sampling_period = debugfs_create_u32("sampling_period",
382                                                  S_IRUSR | S_IWUSR, debugfsdir,
383                                                  &pinfo->sampling_period);
384         de->coeff_p = debugfs_create_u32("coeff_p", S_IRUSR | S_IWUSR,
385                                          debugfsdir, (u32 *)&pinfo->coeff_p);
386         de->coeff_i = debugfs_create_u32("coeff_i", S_IRUSR | S_IWUSR,
387                                          debugfsdir, (u32 *)&pinfo->coeff_i);
388         de->coeff_d = debugfs_create_u32("coeff_d", S_IRUSR | S_IWUSR,
389                                          debugfsdir, (u32 *)&pinfo->coeff_d);
390         de->smoothing_shift = debugfs_create_u32("smoothing_shift",
391                                                  S_IRUSR | S_IWUSR, debugfsdir,
392                                                  &pinfo->smoothing_shift);
393         de->sharpen_factor = debugfs_create_u32("sharpen_factor",
394                                                S_IRUSR | S_IWUSR, debugfsdir,
395                                                &pinfo->sharpen_factor);
396         de->sharpen_duration = debugfs_create_u32("sharpen_duration",
397                                                   S_IRUSR | S_IWUSR, debugfsdir,
398                                                   &pinfo->sharpen_duration);
399         de->norm_offset = debugfs_create_u32("norm_offset",
400                                              S_IRUSR | S_IWUSR, debugfsdir,
401                                              &pinfo->norm_offset);
402 #endif
403
404         return pinfo;
405 }
406
407 static void rate_control_pid_free(void *priv)
408 {
409         struct rc_pid_info *pinfo = priv;
410 #ifdef CONFIG_MAC80211_DEBUGFS
411         struct rc_pid_debugfs_entries *de = &pinfo->dentries;
412
413         debugfs_remove(de->norm_offset);
414         debugfs_remove(de->sharpen_duration);
415         debugfs_remove(de->sharpen_factor);
416         debugfs_remove(de->smoothing_shift);
417         debugfs_remove(de->coeff_d);
418         debugfs_remove(de->coeff_i);
419         debugfs_remove(de->coeff_p);
420         debugfs_remove(de->sampling_period);
421         debugfs_remove(de->target);
422 #endif
423
424         kfree(pinfo->rinfo);
425         kfree(pinfo);
426 }
427
428 static void *rate_control_pid_alloc_sta(void *priv, struct ieee80211_sta *sta,
429                                         gfp_t gfp)
430 {
431         struct rc_pid_sta_info *spinfo;
432
433         spinfo = kzalloc(sizeof(*spinfo), gfp);
434         if (spinfo == NULL)
435                 return NULL;
436
437         spinfo->last_sample = jiffies;
438
439 #ifdef CONFIG_MAC80211_DEBUGFS
440         spin_lock_init(&spinfo->events.lock);
441         init_waitqueue_head(&spinfo->events.waitqueue);
442 #endif
443
444         return spinfo;
445 }
446
447 static void rate_control_pid_free_sta(void *priv, struct ieee80211_sta *sta,
448                                       void *priv_sta)
449 {
450         kfree(priv_sta);
451 }
452
453 static struct rate_control_ops mac80211_rcpid = {
454         .name = "pid",
455         .tx_status = rate_control_pid_tx_status,
456         .get_rate = rate_control_pid_get_rate,
457         .rate_init = rate_control_pid_rate_init,
458         .alloc = rate_control_pid_alloc,
459         .free = rate_control_pid_free,
460         .alloc_sta = rate_control_pid_alloc_sta,
461         .free_sta = rate_control_pid_free_sta,
462 #ifdef CONFIG_MAC80211_DEBUGFS
463         .add_sta_debugfs = rate_control_pid_add_sta_debugfs,
464         .remove_sta_debugfs = rate_control_pid_remove_sta_debugfs,
465 #endif
466 };
467
468 int __init rc80211_pid_init(void)
469 {
470         return ieee80211_rate_control_register(&mac80211_rcpid);
471 }
472
473 void rc80211_pid_exit(void)
474 {
475         ieee80211_rate_control_unregister(&mac80211_rcpid);
476 }